首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

命名约定:动词/名词和英语语法使用指南

命名约定是指在编程和软件开发中,为变量、函数、类等命名时遵循的一些规范和约定。这有助于提高代码的可读性和可维护性。以下是一些常见的命名约定:

  1. 驼峰命名法(CamelCase):在驼峰命名法中,单词的首字母大写,例如:thisIsAVariable。
  2. 下划线命名法(Snake_case):在下划线命名法中,单词之间使用下划线分隔,例如:this_is_a_variable。
  3. 帕斯卡命名法(PascalCase):在帕斯卡命名法中,每个单词的首字母大写,例如:ThisIsAVariable。
  4. 短横线命名法(kebab-case):在短横线命名法中,单词之间使用短横线分隔,例如:this-is-a-variable。

在命名时,应该遵循以下原则:

  1. 选择有意义的名称:变量名应该能够清楚地表达其所代表的含义。
  2. 避免使用缩写:尽量使用完整的单词,以免引起歧义。
  3. 遵循命名规范:根据编程语言的不同,遵循相应的命名规范。
  4. 区分大小写:大部分编程语言中,变量名是区分大小写的。
  5. 避免特殊字符:变量名应该只包含字母、数字和下划线等字符。
  6. 避免使用保留字:不要使用编程语言中的保留字作为变量名。

在命名时,应该尽量简洁明了,以便于代码的阅读和维护。同时,应该遵循相应的编程语言的命名规范,以保证代码的可读性和可维护性。

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

Swift API 设计指南(上)

推荐: let rgbForeground = RGBColor(cmykForeground) 基于函数方法的副作用对它们命名 没有副作用的方法读起来应该是一个名词词组,譬如:x.distance...使用 “ed/ing” 规则对一个可变方法(mutating method)的不可变版本命名。 一般来说,可变方法都会有一个对应的不可变版本,该方法会返回一个接受值相同或者相似类型的值。...copy of `self`. func reversed() -> Self ... x.reverse() let y = x.reversed() - 当动词后面跟了个名词的时候,用过去分词就不符合语法规范了...,这时候可以用动词的现在分词对不可变版本命名,也就是加上 “ing”: /// Strips all the newlines from \`self\` mutating func stripNewlines...用来描述能做什么的协议应该加上 able、ible 或者 ing 进行命名**(譬如:Equatable, ProgressReporting)。 其它类型、属性、变量和约束的命名都应该用名词。 待续

68730

什么,你还在用拼音命名法?

无视英语语法 乍看,将章节信息标为翻译完成,方法名好像也能表达这意思,但经不起推敲。...代码意图“完成翻译”,所以取名: 完成时 completed 翻译的英问 translate 一般命名规则: 类名,名词 表示一个对象 方法名,动词、动宾短语 表示一个动作 以此评判,将方法名改成动宾结构...: 完成 译 complete 翻译 用其名词 translation 所以,方法名应该是 completeTranslation。...再如,一个方法名 retranslation,意图重新翻译,但作为方法名,应该是个动词,所以应该是 retranslate 不准确的英语词汇 某审核功能的审核状态: 有问题吗? 估计你也这么写。...写代码时即可参考这个词汇表给变量函数命名。这也是DDD时构建通用语言的成果。 英语单词的拼写错误 一段蜜汁代码: 居然还会封装查询排序,这确实比那些把字符串传来传去的做法要好。

43220
  • 中国程序员视角下的英文命名

    一般命名规则是: 类名是个名词 表示一个对象 方法名是个动词或动宾短语 表示一个动作 以此为标准判断,completedTranslate 并不是一个有效的动宾结构。...如果把这个名字改成动宾结构,只要把“完成”译为 complete,“翻译”用成它的名词形式 translation 就可以了。...比如,一个函数名是 retranslation,其表达的意图是重新翻译,但作为函数名,它应该是一个动词,所以,正确的命名应该是 retranslate。...一般情况下,我们都可以去业务方谈,共同确定一个词汇表,包含业务术语的中英文表达。这样在写代码的时候,你就可以参考这个词汇表给变量函数命名。...,或者写单词其中的一部分) 如何从实践层面上更好地规避这些坏味道: 制定代码规范,比如,类名要用名词,函数名要用动词或动宾短语 要建立团队的词汇表 要经常进行CR 编写符合英语语法规则的代码。

    74930

    一天一点代码坏味道(1)

    Book book = service.GetByIsbn(isbn); ICacheClient.Put(isbn, book); return book; } 技术人喜欢用技术名词命名...DDD领域驱动设计方法就号召我们建立统一语言,这个统一语言是可以业务部门的人员无障碍交流的语言,换句话说,也就是业务语言。...如果能用中文来命名,我们是不会到处查单词用英文来命名的,但是,用中文,没有B格啊,我放弃! ? 违反语法规则的命名 类是一个名字,表示一个对象。而方法名一般是一个动词或动宾短语,表示一个动作。...),意为重新翻译,但作为方法名,应该选择动词,改为 ReTranslate 会更好(Translate是个动词,棒!)。...4 小结 本文总结了命名相关的两类坏味道,一是命名是否具有业务含义,二是命名是否符合英语语法。 最后,感谢郑晔老师的这门《代码之丑》课程,让我受益匪浅!

    33010

    Java 命名约定

    命名 在 Java 中,类命名一般使用名词,首字母大写的驼峰式命名: public class ArrayList {} public class Employee {} public class...接口命名 在 Java 中,接口命名一般使用形容词。接口名是首字母大写的驼峰式方式。在一些场景中,当接口表示一个类集合,比如List Map,也可以使用名词。...方法命名 方法应该总是使用动词。它们代表某个动作,所以方法名应该尽可能清晰表明这种状态。方法名可以由单个或者 2-3 个单词来表述这种动作。这些单词应该使用驼峰式标记法。...泛型命名约定 泛型参数名应该是单个大写的字符。推荐使用 T 字母。在 JDK 类中,字母 E 通常用于作为集合类中,字母 S 通常用于服务加载类中,字母 K V 通常用于映射类中的键值的类型。...它们可以是形容词,动词或者名词,这基于它们的需求选择。

    27930

    给函数取一个“好”的名字

    常见函数命名风格 目前来说,最常见的函数命名主要有两种风格:驼峰命名帕斯卡命名。...每个单词的首字母大写; public void SetUserName(String userName); 两种命名风格都是ok的,但要保证一点,对于一个团队或者一个项目,需要根据语言本身的推荐命名方式做好约定...函数命名最佳实践 1)要领1:动词选取要精准 通常来说,动词决定了一个函数要采取什么"动作"。动词取的好,一个函数名字已经成功了80%。...动词决定了函数的具体动作,而名词决定了函数具体的操作对象,对于名词,尽量使用领域词汇,不要使用生僻或者大家很少使用的词语。...再比如,假如使用到建造者模式,那么通常会用build作为函数名字,这个时候就不要另辟蹊径,用create来作为函数名字,使用大家约定俗成的命名习惯更容易让你的代码被别人读懂。

    1.5K20

    探索命名之美(一)

    三、 如何给一个函数命名 我认为,可以通过以下六种方法进行函数命名: 基于已有认知。如果在领域里已经有一些约定俗成的函数命名,最好直接拿来用,比如I18N、L10N等。...新词最好由约定俗成的命名所构成,例如PointX。 尽量反映函数的通用性。...四、 Mathematica 7 命名统计分析 Mathematica是一款科学计算软件,很好地结合了数值符号计算引擎、图形系统、编程语言、文本系统、与其他应用程序的高级连接。...mathenmatica7.png 统计结果分析: 通过上述分析结果可以看出,名词动词占了命名的最大比例。在对其中的名词动词进行进一步分析之后,结论如下: 表述实体或者属性时,用名词或者名词词组。...表述一个动作时,用动词或者动词词组。其中,若动作针对特殊实体,往往将实体名带上,如DeleteCases、FindRoot等;若动作属于通用性动作,则不带实体名,如Insert、Scan。

    52930

    一文了解路由平台的 Cisco IOS IOS XE 命名约定,看这篇就够了!

    TOC 概述 命名约定一致性 对某事物进行任何命名约定的全部意义在于使事物保持一致和统一。...遵守约定可为专业人员提供基本规则,让他们坚持已知的内容,为现在未来的员工以及使用思科产品的人员提供清晰简洁的信息。...本文概述了Cisco 路由平台的 Cisco IOS 命名约定,包括 IOS XE 版本 3S、16 17 以及 IOS Classic 版本 15M&T、15S 15 特殊早期部署。...IOS XE 的优势在于为企业、有线无线接入、聚合、核心广域接入网络提供单一操作系统的优势。...重建编号通常表示某些错误修复将发生的位置,重建可以有数字约定、字母、小写字母约定,甚至两者的混合。

    1.3K21

    Carson带你学Android:这是一份全面 & 详细的Android代码命名规范

    下面我列举出一些常见 & 需要规范的4级功能包名 3.2 类 基础规则 类型 = 名词 / 名词短语; 形式 = 驼峰形式中的 大骆驼拼写法(UpperCamelCase) 即名称中的每个词的首字母都大写...,如 AndroidStudio 在具体命名类时,会根据 该类的类型不同而附加额外的命名规则。...具体如下图 3.3 变量 基础规则 类型 = 名词 / 名词短语; 形式 = 驼峰形式中的 小骆驼拼写法(LowerCamelCase) 即名称中的第1个词的首字母小写,后面每个词的首字母大写...具体如下图 3.4 方法 基础规则 类型 = 动词 / 动词短语; 形式 = 驼峰形式中的 小骆驼拼写法(LowerCamelCase) 即名称中的第1个词的首字母小写,后面每个词的首字母大写...附录:常见使用单词缩写表 使用单词缩写的原则:只使用约定俗成的单词缩写 严禁自由缩写单词 具体如下图 5. 总结 看完本文后,相信你以后会认真对待 Android代码命名了!

    61510

    规范JavaScript命名

    :首字母小写 studentInfo、userInfo、productInfo 变量 命名方法:小驼峰式命名命名规范:前缀应当是名词。...(函数的名字前缀为动词,以此区分变量函数) 命名建议:尽量在变量名字中体现所属类型,如:length、count等表示数字类型;而包含name、title表示为字符串类型。...= 'LoginTable'; 函数 命名方法:小驼峰式命名命名规范:前缀应当为动词。...命名建议:可使用常见动词约定 动词含义返回值can判断是否可执行某个动作(权限)函数返回一个布尔值。true:可执行;false:不可执行has判断是否含有某个值函数返回一个布尔值。...② 私有属性方法:前缀为_(下划线),后面跟公共属性方法一样的命名方式。

    2.2K20

    javascript【写法规范】

    目的 提高代码可预测性可维护性的方法是使用命名约定,这就意味着采用一致的方法来对变量函数进行命名。 2. 变量名 变量名包括全局变量,局部变量,类变量,函数参数 3....必须采用全大写的命名,且单词以_分割,常量通常用于ajax请求url,一些不会改变的数据。 7....函数命名 普通函数:首字母小写,驼峰式命名,统一使用动词或者动词+名词形式 例如: fnGetVersion(),fnSubmitForm(),fnInit();涉及返回逻辑值的函数可以使用is,has...内部函数:使用_fn+动词+名词形式,内部函数必需在函数最后定义。...fn+对象类名+动词+名词形式; 例如: fnAddressGetEmail(), 事件响应函数:fn+触发事件对象名+事件名或者模块名 例如:fnDivClick(),fnAddressSubmitButtonClick

    47020

    Android:这是一份全面 & 详细的Android代码命名规范

    3.2 类 基础规则 类型 = 名词 / 名词短语; 形式 = 驼峰形式中的 大骆驼拼写法(UpperCamelCase) 即名称中的每个词的首字母都大写,如 AndroidStudio 在具体命名类时...---- 3.3 变量 基础规则 类型 = 名词 / 名词短语; 形式 = 驼峰形式中的 小骆驼拼写法(LowerCamelCase) 即名称中的第1个词的首字母小写,后面每个词的首字母大写,如androidStudioTool...在具体命名变量时,会根据该变量的类型不同而 附加额外的命名规则。...3.4 方法 基础规则 类型 = 动词 / 动词短语; 形式 = 驼峰形式中的 小骆驼拼写法(LowerCamelCase) 即名称中的第1个词的首字母小写,后面每个词的首字母大写,如androidStudioTool...附录:常见使用单词缩写表 使用单词缩写的原则:只使用约定俗成的单词缩写 严禁自由缩写单词 具体如下图 ? ---- 5.

    3.6K41

    Java中的命名规则

    在较小的层面上,这似乎没有意义,但考虑到工业层面,为了节省时间,有必要编写干净的代码,因为已经制定了某些规则,其中一个因素是命名关键字这在Java中被称为命名约定。...例子: 类: 如果您要命名任何类,那么它应该是一个名词,因此应该根据程序中要实现的目标来命名,例如Add2Numbers、ReverseString等等。不太可能是A1、Programming等。...考虑一下,如果您要创建一个接口来进行读取操作,那么建议根据java中的命名约定命名一个像“Readable”一样的接口。...Java中的命名规则 在java中,将类、变量方法命名为它们实际应该做的事情,而不是随机命名,这是一种很好的做法。下面是java编程语言的一些命名约定。...类型 1: 类接口 类名应为名词,在混合情况下,每个内部单词的首字母大写。接口名称也应该像类名一样大写。 使用完整的单词,必须避免使用缩略语缩写词。

    99610

    探索命名之美(二)

    如果在领域里已经有一些约定俗成的函数命名,最好直接拿来用。 尽量反映函数的通用性。 能望文生义。好的命名应该一目了然,而且针对不同的情况应该做不同的命名。 由句到词。...例如在只有一个Button的View结构中,按钮可以命名为button,因为上下文决定了这个button是唯一的。 使用固定的组合结构,例如表示事物用名词或者名词+名词,表示动作用动词或者动词+宾语。...必要时,可以去参考下权威的SDK或者API的函数命名,跟着权威的思路方法走走不会出错。具体会在下文给出示例。 注释。如果真的不想花时间思考命名,那至少请给出注释。..., UITableViewStyleGrouped 命名是一个很困难的过程,即便这些理论方法我已经很熟悉,但是在日常的编码时还是会遇到各种各样的困难。...大家有遇到命名困难的时候可以多身边的同事讨论,当然也欢迎留言和我进行讨论,一起为写出简单易懂的代码而努力。 希望小文能帮助对各位朋友的工作与学习起到帮助的作用。:)

    42920

    python变量常量命名、注释规范

    参考链接: Python变量,常量和文字 学习python编程前先学习一下变量常量命名规范以及注释规范,要从一开始就养成良好习惯,避免将来遇到一些不必要的麻烦。...取名时要遵循一些原则,通常变量、常量是指某一事物或事物的某一属性,所以变量名、常量名通常使用英文的一个或多个名词命名。...而方法(又称函数)是指执行某一动作,所以方法(函数)名通常使用英文的动词动词名词组合命名。在编写代码时提前准备好英汉双语词典软件很有必要。...常量   字母全部大写,由下划线连结各个单词,如:   HEIGHT = 300 WINDOW_HEIGHT = 300   注意在python中常量是python程序员约定俗成的规矩,实质上python..._salary = 6666   类名   首字母大写,用驼峰风格,如:   class NewStudent(object):   模块包   全部以小写字母组成,用下划线连接   系统保留命名

    2K20

    Java 命名规范(非常全面)

    命名规范 包(Package)的作用是将功能相似或相关的类或者接口进行分组管理,便于类的定位查找,同时也可以使用包来避免类名的冲突访问控制,使代码更容易维护。...通常,包名使用小写英文字母进行命名,并使用“.”进行分割,每个被分割的单元只能包含一个名词。...类命名规范 类(Class)通常采用名词进行命名,且首字母大写,如果一个类名包含两个以上名词,建议使用驼峰命名(Camel-Case)法书写类名,每个名词首字母也应该大写。...一般地,类名的书写尽量使其保持简单描述的完整性,因此在书写类名时不建议使用缩写(一些约定俗成的命名除外。...一般地,在对方法进行命名时,通常采用动词/动词+名词的组合,下面是方法命名的一些常见示例。

    24.7K78

    DDD摸鱼套路示例一

    组合技巧一:动词-名词+“Workflow”,放在活动(结点)处。得到“Place-Order Workflow”“Ship-Order Workflow”。...组合技巧二:名词-动词ing,放在泳道处。得到Order-TakingShipping。...*“换词”也是许多敏捷DDD“发明家”的常用技巧。* 组合技巧三:名词动词ed(注意,此处没有“-”了,又有了“新意”)+“event”,放在活动的输出针脚处。...组合技巧四:动词名词(注意,此处没有“-”了,又有了“新意”)+“command”,,放在活动的输入针脚处。得到“ShipOrder command”。...图8-23 图8-17的终极简化 然后这样约定约定1:必要时可以按照以上归纳的四个组合技巧刷工作量。 约定2:通过队列传递事件。 这两条约定可以应用于各个领域。

    29620
    领券