Questions tagged «naming-conventions»

命名约定是指管理分配给编程结构(例如变量和方法)的名称的通用规则。这些约定通过增强跨不同模块的命名一致性来提高可读性,从而提高代码的可维护性。

5
命名cookie-最佳做法
已关闭。这个问题是基于观点的。它当前不接受答案。 想改善这个问题吗?更新问题,以便通过编辑此帖子以事实和引用的形式回答。 5年前关闭。 改善这个问题 Cookie名称应是什么样? 他们应该是: 小写 骆驼香烟盒 Underscore_Camel_Case UPPER_CASE 还是应该别的东西?



5
获取数据的方法名称
已关闭。这个问题是基于观点的。它当前不接受答案。 想改善这个问题吗?更新问题,以便通过编辑此帖子以事实和引用的形式回答。 5年前关闭。 改善这个问题 警告:这是我发布的不是很严重的问题/讨论,但是我敢打赌大多数开发人员都在考虑这个“问题” ... 一直想就方法的命名约定获取其他意见,这些方法从某处获取数据并返回该数据... 大多数方法名称有些简单明了... SaveEmployee(),DeleteOrder(),UploadDocument()。当然,对于类,您最有可能分别使用简短形式... Save(),Delete()和Upload()。 但是,我一直在努力采取初步措施……如何获取数据。似乎对于每个项目,我最终都会在不同的命名约定之间跳来跳去,因为我对上一个使用的项目从来都不满意。据我所知,这些可能性-> GetBooks() FetchBooks() RetrieveBooks() FindBooks() LoadBooks() 你在想什么

6
模块的Python命名约定
我有一个模块,其目的是定义一个称为“ nib”的类。(以及一些相关的类。)我应该如何调用模块本身?“笔尖”?“ nibmodule”?还要别的吗?

6
抽象类的命名约定
我清楚地记得,曾经有一次,Microsoft提出的指导方针是将“ Base”后缀添加到抽象类中,以消除它是抽象的事实。因此,我们有类,如System.Web.Hosting.VirtualFileBase,System.Configuration.ConfigurationValidatorBase,System.Windows.Forms.ButtonBase,,当然,System.Collections.CollectionBase。 但是我注意到,最近,框架中的许多抽象类似乎都没有遵循这个约定。例如,以下类都是抽象的,但不遵循此约定: System.DirectoryServices.ActiveDirectory.DirectoryServer System.Configuration.ConfigurationElement System.Drawing.Brush System.Windows.Forms.CommonDialog 这就是我可以在几秒钟内完成的工作。因此,我去查找官方文档中要说的内容,以确保我没有发疯。我在《开发类库的设计指南》上的MSDN上找到了类,结构和接口的名称。奇怪的是,我找不到提及在抽象类名称的末尾添加“ Base”的准则。并且指南不再适用于框架的1.1版。 那么,我会失去它吗?该指南曾经存在吗?只是一言不发就被遗弃了吗?在过去的两年中,我是否一直独自创建长类名称? 有人在这里扔我一根骨头。 更新 我不疯。该准则存在。Krzysztof Cwalina于2005年加入了这项计划。

24
数据库表中ID列的命名
我想知道人们对数据库表中ID列的命名有何看法。 如果我有一个名为Invoices的表,且其标识列的主键为该表,则应将该列称为InvoiceID,这样我就不会与其他表发生冲突,这很明显。 在我目前工作的地方,他们已经将所有ID列称为ID。 因此,他们将执行以下操作: Select i.ID , il.ID From Invoices i Left Join InvoiceLines il on i.ID = il.InvoiceID 现在,我在这里看到一些问题: 1.您将需要对select的列进行别名 2. ID = InvoiceID不适合我的大脑 3.如果您未对表进行别名并引用InvoiceID,那么显然是哪个表它开着? 其他人对此话题有何看法?

3
Scala常数的命名约定?
Scala常数的命名约定是什么?简要搜索StackOverflow建议使用大写的CamelCase(下面的第一行),但是我想仔细检查一下。 val ThisIsAConstant = 1.23 val THIS_IS_ANOTHER_CONSTANT = 1.55 val thisIsAThirdConstant = 1.94 推荐哪种Scala样式?


13
XML元素是否有标准的命名约定?[关闭]
关闭。此问题不符合堆栈溢出准则。它当前不接受答案。 想改善这个问题吗?更新问题,使其成为Stack Overflow 的主题。 3年前关闭。 改善这个问题 是否存在XML文档的事实上的标准或其他标准?例如,哪种是编写标签的“最佳”方法? <MyTag /> <myTag /> <mytag /> <my-tag /> <my_tag /> 同样,如果我有一个更好的属性的枚举值 <myTag attribute="value one"/> <myTag attribute="ValueOne"/> <myTag attribute="value-one"/>

5
为什么pylint反对单字符变量名?
我仍然习惯于使用python约定并使用pylint使我的代码更具pythonic风格,但是我对pylint不喜欢单字符变量名感到困惑。我有几个这样的循环: for x in x_values: my_list.append(x) 当我运行时pylint,我得到Invalid name "x" for type variable (should match [a-z_][a-z0-9_]{2,30}-这表明一个有效的变量名长度必须在3到31个字符之间,但是我浏览了PEP8命名约定,但没有看到任何有关单个小写字母的明确信息,我确实看到了很多使用它们的示例。 在PEP8中我缺少什么还是这是pylint特有的标准?

30
使用仅与大小写不同的变量名是否不道德?
例如,使用这段代码: var person = new Person(); 或适合您的Pythonista用户: person = Person() 经常有人告诉我这有多糟,但是还没有看到这两行代码不道德的例子。在我看来,人就是人,而尝试给它起另一个名字是浪费时间。我想在语法突出显示之前的日子里,这会是一件大事。但是如今,很容易分辨出类型名和变量名。哎呀,这很容易看出SO的区别。 还是我想念的东西?如果是这样,如果您可以提供一个导致问题的代码示例,将很有帮助。

13
主键/外键命名约定
已关闭。这个问题是基于观点的。它当前不接受答案。 想改善这个问题吗?更新问题,以便通过编辑此帖子以事实和引用的形式回答。 4年前关闭。 改善这个问题 在我们的开发小组中,我们对主键和外键的命名约定进行了激烈的辩论。我们小组基本上有两种思想流派: 1: Primary Table (Employee) Primary Key is called ID Foreign table (Event) Foreign key is called EmployeeID 要么 2: Primary Table (Employee) Primary Key is called EmployeeID Foreign table (Event) Foreign key is called EmployeeID 我不希望在任何列中重复表的名称(因此,我更喜欢上面的选项1)。从概念上讲,它与其他语言中的许多推荐做法是一致的,在这种情况下,不要在对象的属性名称中使用对象的名称。我认为命名外键EmployeeID(或Employee_ID可能更好)可以告诉读者这是表的ID列Employee。 其他一些人则更喜欢选项2,在该选项中,您将主键命名为表名,以使整个数据库中的列名相同。我明白了这一点,但是现在您无法从视觉上区分主键和外键。 另外,我认为将表名包含在列名中是多余的,因为如果您将表视为实体,而将列视为该实体的属性或属性,则将其视为的ID属性,而Employee不是EmployeeID员工的属性。我不走了问我的同事他什么PersonAge或者PersonGender是。我问他他的年龄是多少。 因此,就像我说的那样,这是一场激烈的辩论,我们将继续对此进行讨论。我有兴趣获得一些新观点。

7
返回布尔值的Java方法的命名约定(无问号)
我喜欢用其他语言在方法/函数名称的末尾使用问号。Java不允许我这样做。作为一种解决方法,我还能如何用Java命名布尔返回方法?使用is,has,should,can在好一些情况下,方法声音的前端。是否有更好的方法来命名此类方法? 例如,createFreshSnapshot?

2
部分类文件的命名约定
我正在生成大量的ASP.NET MVC脚手架代码。所有生成的文件都是使用标准命名约定的部分类。例如,我的员工控制器文件名为EmployeeController.cs。如果希望使用自定义的,未生成的逻辑扩展EmployeeController,则创建另一个名为EmployeeControllerCustom.cs的部分类文件。我将自定义和生成的逻辑分为两个不同的文件,因此,下次生成EmployeeController时,我的自定义更改不会被覆盖。在文件名中添加“自定义”后缀对我来说似乎很合理,但是我应该遵循更完善的部分类文件命名约定吗?

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.