问题标签 [naming-conventions]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
33 回答
29038 浏览

coding-style - 您对成员变量使用什么样的前缀?

毫无疑问,对于理解代码来说,给成员变量一个前缀是很重要的,这样它们就可以很容易地与“正常”变量区分开来。

但是你使用什么样的前缀?

我一直在处理我们使用m_作为前缀的项目,在其他项目中我们只使用下划线(我个人不喜欢,因为只使用下划线不够说明)。

在另一个项目中,我们使用了长前缀形式,它也包括变量类型。例如mul_是u nsigned long类型的成员变量的前缀。

现在让我知道您使用哪种前缀(并请说明原因)。

编辑:你们中的大多数人似乎在没有为成员变量添加特殊前缀的情况下编写代码!这取决于语言吗?根据我的经验,C++ 代码倾向于使用下划线或m_作为成员变量的前缀。其他语言呢?

0 投票
7 回答
10330 浏览

naming-conventions - 用于在代码隐藏中引用的 UI 控件命名约定的最佳实践?

命名表单和报告上的 UI 控件(文本框、下拉列表等)以供代码隐藏页面参考的最佳做法是什么?

我在办公室里开发了很多报告和表格。我有几个 Web 应用程序提供大约 80 多个“实时”报告,这些报告是从各种和多个数据源(Access、SQL、Oracle)生成的。这些报告被认为是“实时的”,因为它们接受来自表单的用户设置参数,然后查询数据库以根据当前可用信息生成报告。

因此,该过程从获取用户设置的值开始,将这些值传递给数据库查询,接收数据集,最后将数据集分配给报表。在某些情况下,需要从数据集计算报表上显示的其他字段,然后才能生成报表。这需要参考报表上的输出控件来分配计算值。

虽然我并不真正关心在我的代码中为变量或成员字段使用前缀,但我确实使用它们来标识 UI 控件。例如,txtFirstName 引用报表控件以将数据集中 FirstName 字段中的数据分配给报表上的显示控件。是否有更好的做法来命名/引用表单和报告上的 UI 控件?

0 投票
37 回答
142020 浏览

language-agnostic - 为什么我不应该使用“匈牙利符号”?

我知道匈牙利语指的是什么 - 提供有关变量、参数或类型的信息作为其名称的前缀。每个人似乎都强烈反对它,尽管在某些情况下这似乎是一个好主意。如果我觉得有用的信息正在被传递,为什么我不应该把它放在可以得到的地方呢?

另请参阅:人们在现实世界中使用匈牙利命名约定吗?

0 投票
6 回答
458 浏览

web-services - 在与 Web 服务通信时,我应该在我的方法前面加上“get”还是“load”?

我正在编写一个与 Web 服务通信的桌面应用程序。您能否将所有获取数据的 Web 服务函数命名为Load XXXX,因为它们需要一段时间才能执行。或者你会使用Get XXXX,例如当只获取一个对象时。

0 投票
1 回答
848 浏览

oop - 有没有人有关于 n 层 Web 应用程序的类命名的好文章或好的建议?

我习惯了 LLBLGen 在基于数据库结构生成对象时给出的布局,这可能会为数据库中的给定“用户”表生成以下类文件:

这为数据访问提供了一些基本功能。但是,当您想在此之上实现业务逻辑时,您将如何布局?例如,给定一个可能如下所示的表结构:

如果您想锁定用户怎么办?你会从表示层调用什么代码?您会实例化 UserEntity 类,然后执行以下操作:

或者您会创建一个新类,例如 UserHelper (/BusinessLogic/UserHelper.cs),它可能具有 LockOutUser 函数。这会将代码更改为:

或者您会扩展基本的 UserEntity 类,并创建添加新功能的 UserEntityExt?因此,表示层的代码可能如下所示:

或者......你会完全做其他事情吗?

您的目录/命名空间结构和文件/类命名约定是什么?

0 投票
18 回答
103792 浏览

url - URL:破折号与下划线

应该是/about_us还是/about-us

从可用性的角度来看,我个人认为/about-us对最终用户来说要好得多,但谷歌和大多数其他网站(和 javascript 框架)使用下划线命名模式。只是风格问题吗?破折号是否存在兼容性问题?

0 投票
2 回答
12888 浏览

java - Jar 文件命名约定

命名 jar 文件是否有任何行业标准约定?

0 投票
7 回答
1027 浏览

.net - 您在编码时使用的命名约定是什么?

您在编码时使用的命名约定是什么?

0 投票
21 回答
1271 浏览

variables - 一个名为 i 的变量是不可接受的吗?

就变量命名约定而言,应该命名迭代器i还是更语义化的东西count?如果你不使用i,为什么不呢?如果您认为这i是可以接受的,是否存在不应该使用它的迭代案例?

0 投票
4 回答
1690 浏览

java - 太多“模式后缀”——设计气味?

我刚刚发现自己创建了一个名为“InstructionBuilderFactoryMapFactory”的类。这是一个类的 4 个“模式后缀”。它立刻让我想起了这一点:

http://www.jroller.com/landers/entry/the_design_pattern_facade_pattern

这是设计的味道吗?我应该对这个数字施加限制吗?

我知道一些程序员对其他事情有类似的规则(例如,在 C 中不超过 N 级指针间接。)

所有的课程对我来说都是必要的。我有一个从字符串到工厂的(固定)映射——我一直在做的事情。该列表越来越长,我想将其移出使用构建器的类的构造函数(由从地图获得的工厂创建......)并且像往常一样,我避免使用单例。