logo标签列表

你遵循哪些Delphi编码规范文档？

delphinaming-conventionscoding-style
21
您遵循哪些Delphi编码标准文档？
我们公司正在考虑制定更好的编码标准，以提高我们代码的可读性、可审查性和可维护性。我们看到了CodeGear的“Object Pascal Style Guide”，但它已经有一段时间没有更新了，我想许多人可能进行了一些本地改进或添加。我找到了一些发布的变体和其他文档，如下所示。
注意：我不想发动一场格式战。我只想知道您遵循的标准及其原因。
谢谢。
更新：嗯，“JCL Delphi Language Style Guide”似乎是最受欢迎的！谢谢！
所有这些格式化的“标准”都是毫无意义的。没有进行任何研究证明哪种方法比其他方法更好...哦...你在哪里，Wirth？ - Gabriel
8个回答
21
大多数情况下，我遵循这个标准。我的例外是，在放置编辑组件时，我通常会在它们的前缀中加上“ed”（不管是编辑框、备忘录还是组合框）。对于按钮，我会在前缀中加上“btn”。 - skamradt
2
答案中的链接已经失效，但我认为这是你要找的文章：http://jcl.delphi-jedi.org/documents/styleguide.html，并且这是一个很好的附加资源：http://jvcl.delphi-jedi.org/StyleGuide.htm。 - Jeroen Wiert Pluimers
1
现在它重定向到 http://wiki.delphi-jedi.org/index.php?title=Style_Guide。 - AmigoJack
5

CodeGear的“Object Pascal风格指南”

http://edn.embarcadero.com/article/10280

这是一篇关于Object Pascal编程规范的指南，提供了一系列最佳实践，以帮助开发人员编写更加高效、清晰和易于维护的代码。如果您正在使用Object Pascal进行IT技术开发，那么这篇文章将对您非常有用。
2

Econos - 编码标准文档

(副标题为“Delphi 4 开发人员指南编码标准文档”)

http://www.econos.de/delphi/cs.html


注：此文档为Econos公司编写的Delphi编码规范，适用于开发者参考和遵循。
啊，那些好老师Xavier Pacheco、Steve Teixeira和Stefan Hoffmeister！我一直关注前两者，但不知道Stefan发生了什么。 - Jeroen Wiert Pluimers
链接已失效，请尝试访问以下链接：http://box.cs.istu.ru/public/docs/other/_New/Books/Lang/Delphi/Delphi%20Developer's%20Guide/Ebooks/d5dg/chapter6.pdf 或者 http://www.sourceformat.com/coding-standard-delphi-econos.htm。 - rhody
2
1
链接失效。找不到原始文件。 - Grim
谢谢，@Peter Rader。链接已更改为使用Wayback Machine。 - Mattias Andersson
1

只要你选择一个并坚持使用，那么它真的无关紧要。编码标准就像方言一样，只要团队中的每个人都说同一种方言，那就没问题。

话虽如此，为什么不选择与您的运行时库（VCL）和文档使用相同的标准呢？然后，您所有人都将说同一种方言，并且在阅读运行时库代码时会更容易。而且有大量的代码示例来说明编码约定。

这是一个非常好的观点，我很感激你提出来。谢谢！话虽如此，我们想要选择一个倾向于“完整”一面的标准，因此VCL文档可能不是最好的选择。 - Mattias Andersson
我个人的信念是，少即是多，在一天结束时，你能在标准文档中捕捉到的规则对于可维护性来说远不如程序员的态度和经验重要。 - Jozz
1

在编写代码时，有一种倾向是过度设计编码标准，以至于它们妨碍了编写代码。

我同意Jozz的评论。你可以查看所有推荐的标准，选择一个并强制执行它，或者你可以让你的团队参与到这个过程中。

根据我的经验，让团队提出想法和采用标准的好处是激发团队积极性的最佳方式。你现有的人才是你最好的资源。同样，如果你强迫他们走不认同的道路，他们也可能成为你的终极敌人。

因此，请查看您现有的编码变体，并让团队进行一些充满活力的讨论：

  • 采用编码标准的原因。
  • 标准化的基本考虑因素。
  • 揭示团队对这个问题的任何不安全感。
  • 找到一个共识点。什么重要，什么不重要。
  • 建立一些企业目标，让每个人都感觉自己在朝着共同的目标努力。
  • 让团队向自己销售标准化的好处。

最重要的目标必须是建立一个最适合您的团队和公司的“标准”。

1

由于某些无聊的历史原因，我们公司的编码标准是在 Delphi 和 SQL 中将所有关键字都大写。感谢上帝有大写锁定键。

-3
网页内容由stack overflow 提供, 点击上面的
可以查看英文原文，
原文链接