问题标签 [naming-conventions]

这似乎是一个简单的问题，但我无法通过 Stack Overflow 搜索或 Google 找到它。一个类型后跟一个_t意思是什么？如

我在旨在密切处理硬件的 C 代码中看到了很多——我不禁认为它们是相关的。

这是Big Nerd Ranch的 Charles Brian Quinn在acts_as_conference的演讲中最初讨论的内容。他正在讨论他从向许多编程新手和 Rails 新手指导 Ruby on Rails 训练营中学到的东西。

一张特别突出的幻灯片是在尝试教某人编程时从不使用 foo 和 bar 作为示例。他的理由很简单。

哪个更容易理解？

或者

我自己在解释某事时发生了很多次，我立即跳到 go to foo bar 占位符，但随后意识到我的错误，并通过使用真实世界的场景使示例更有意义。

这在尝试教没有编程经验的人时尤其适用，并且您最终需要在解释您实际尝试教的内容之前解释 foo 和 bar。

然而，对于有经验的程序员来说，使用 foo 和 bar 似乎没问题，尽管我个人认为，与 Charles 一样，这是需要改变的东西。

快速搜索“foo”会返回超过 20 页的结果，其中 foo 以我可以理解的更多方式使用。在某些情况下，我正在阅读有关特定语言的问题，我这样做是为了帮助更好地理解该语言。如果使用适用的变量名而不是 foo 和 bar，则更容易理解和解释问题。所以对于经验丰富的开发人员来说，这个结构似乎也有点缺陷。

这是一个永远可以被踢掉的习惯吗？你为什么选择 foo bar 或不 foo bar？

我来自 .NET 世界，并且是编写 C++ 的新手。我只是想知道在命名局部变量和结构成员时首选的命名约定是什么。

例如，我继承的遗留代码有很多：

来自 C# 背景的我很震惊地看到带有匈牙利符号的变量（我第一次看到 pp 前缀时就忍不住笑了）。

我宁愿以这种方式命名我的变量（尽管我不确定首字母大写是否是一个好的约定。我见过其他方式（见下面的链接））：

我的问题：这（前一种方式）是否仍然是在 C++ 中命名变量的首选方式？

参考：

http://geosoft.no/development/cppstyle.html

http://www.syntext.com/books/syntext-cpp-conventions.htm

http://ootips.org/hungarian-notation.html

谢谢！

这是一个快速的问题。哪个方法名称对 Objective-C Cocoa 应用程序最有意义？

或者：

甚至：

这些年来，我遇到了许多不同风格的变量名。

当前关于命名约定的维基百科条目相当简单......

我希望看到一个简洁的变量命名约定目录，通过名称/描述来识别它，以及一些示例。

如果某个约定特别受到某个平台社区的青睐，那也值得注意。

我正在把它变成一个社区维基，所以请为每个约定创建一个答案，并根据需要进行编辑。

我已经看到了命名存储过程的各种规则。

有些人在 sproc 名称前加上 usp_，有些人使用应用程序名称的缩写，还有一些人使用所有者名称。除非您是认真的，否则不应在 SQL Server 中使用 sp_。

一些以动词（获取、添加、保存、删除）开头的过程名称。其他人则强调实体名称。

在具有数百个存储过程的数据库上，当您认为已经存在一个存储过程时，可能很难滚动并找到合适的存储过程。命名约定可以使定位存储过程更容易。

你使用命名约定吗？请描述它，并解释为什么你更喜欢它而不是其他选择。

回复摘要：

• 每个人似乎都提倡命名的一致性，因为每个人使用相同的命名约定可能比使用哪个特定的命名约定更重要。
• 前缀：虽然很多人使用 usp_ 或类似名称（但很少使用 sp_），但许多其他人使用数据库或应用程序名称。一位聪明的 DBA 使用 gen、rpt 和 tsk 来区分一般的 CRUD 存储过程和用于报告或任务的存储过程。
• 动词+名词似乎比名词+动词更受欢迎。有些人对动词使用 SQL 关键字（Select、Insert、Update、Delete），而另一些人则使用非 SQL 动词（或它们的缩写），例如 Get 和 Add。有些人区分单数名词和复数名词，以表明是否正在检索一条或多条记录。
• 在适当的情况下，建议在末尾添加一个附加短语。GetCustomerById，GetCustomerBySaleDate。
• 有些人在名称段之间使用下划线，而有些人则避免使用下划线。app_Get_Customer 与 appGetCustomer——我想这是可读性的问题。
• 大型存储过程集合可以分离到 Oracle 包或 Management Studio (SQL Server) 解决方案和项目，或 SQL Server 模式中。
• 应避免使用难以理解的缩写。

为什么我选择我所做的答案：有很多好的回应。谢谢你们！如您所见，很难只选择一个。我选择的那个引起了我的共鸣。我遵循了他描述的相同路径——尝试使用动词+名词，然后找不到适用于客户的所有存储过程。

能够定位现有的 sproc，或者确定一个是否存在，是非常重要的。如果有人无意中创建了另一个名称的重复存储过程，则可能会出现严重问题。

由于我通常处理具有数百个存储过程的大型应用程序，因此我更喜欢最容易找到的命名方法。对于较小的应用程序，我可能会提倡动词 + 名词，因为它遵循方法名称的一般编码约定。

他还提倡以应用名称为前缀，而不是用不太有用的 usp_。正如一些人指出的那样，有时数据库包含多个应用程序的存储过程。因此，使用应用程序名称作为前缀有助于隔离存储过程并帮助 DBA 和其他人确定存储过程用于哪个应用程序。

或者

我个人认为对于现代 IDE，我们应该使用 camelCase，因为 ALL_CAPS 看起来很奇怪。你怎么看？

我是一名没有正式计算背景的网络开发人员，我已经编写代码几年了，但是每次我需要创建一个新的类/函数/变量时，我都会花大约两分钟的时间来决定一个名字然后是如何输入。

例如，如果我编写一个函数来总结一堆数字。我应该叫它吗

我知道有一种正确的方法可以做到这一点，我只需要一个指向良好权威来源的链接：D

作为c# 编码标准/最佳实践的副本关闭

我最近推出了一个应用程序，它使用 PGP 自动加密从另一个内部系统输出的文件，然后 sftp'd 到外部目标服务器目录，供第三方应用程序使用。我一直在尝试解决整个过程大约一周的问题，直到今天早上在电子邮件中没有收到第三方的回复......

“<em>原来，文件命名不正确，所以系统认为你没有提交它。有一个大写的“T”应该小写。”</p>

行。在深深叹了口气之后（因为没有其他人可以访问该目录并且没有其他以类似方式命名的文件），我开始怀疑，“<strong>应用程序何时应该尊重密码之外的用​​户输入区分大小写？” 我在这里通过我的大脑试图想一个时间，我希望“文件名”和“文件名”有意识地表示不同的东西。

顺便说一句，我不是在谈论应用程序内变量命名约定。我实际上非常喜欢区分大小写的语言。

您遵循哪些 Delphi 编码标准文档？

我们公司正在考虑制定一些更好的编码标准，以提高我们代码的可读性、可审查性和可维护性。我们遇到了 CodeGear 的“Object Pascal 样式指南”，但很长一段时间都没有接触过它，我想很多人已经对本地进行了一些改进或添加。我遇到了一些已发布的变体和其他文档，我将在下面列出。

注意：我不想开始一场风格大战。我只是想知道你遵循什么标准，以及为什么。

谢谢。