3

在哪里阅读(最佳实践)源代码格式,对于个别语言,即命名变量等的约定是什么,缩进和放置大括号的位置,如何以及在哪里包含注释等。

例如对于 C Kernighan 和 Ritchie 的书The C Programming Language和 Linus Torvalds 的Linux kernel coding style guideGoogle 的 C++ Style Guide和 Perl 至少perlstyle - Perl style guide

编辑:也许我应该问“如何从编码风格开始”。

4

9 回答 9

3

我不会在这样的风格指南上给出太多。它们是一个好的开始,但最终您或您的团队将开发自己的编码风格。

编辑:Rob Kam 发表评论说,他想了解更多关于这些“启动约定”的信息。

那是个很好的观点。但大多数情况下,你会加入现有项目、开源项目或商业项目,而从事它的人已经有了代码约定。在一家公司中可能已经存在一个代码约定。如果您开始一个新项目,请从您之前所做的另一个项目的约定开始。

如果你真的用一种你以前没有使用过的新语言开始一个新项目......那么你可能会从另一种语言的约定开始,这种约定在某种程度上相似(即,对于一种新的 oo 语言,你可以使用 Java 或 Smalltalk 的约定)并在您获得新语言经验时调整您的约定。当我开始用 Java 编程时,我使用了我的 Pascal-coding-conventions。一些 pascal 约定对 Java 来说不是很好,但随着时间的推移,我放弃了一些旧的约定并开发了新的约定。

S.Lott 的想法是研究一个用您选择的语言编写的开源项目。获得有关良好约定的一些建议是个好主意。Srikanth 有一个好主意,可以在 Stackoverflow 上提出好的约定。一个非常好的主意,因为随着时间的推移,Stackoverflow 将成为这种编码约定的良好参考。

于 2008-10-24T10:09:40.680 回答
1

比一本书更好的是找到你喜欢的语言的开源代码。

而不是一本书——少数作者和编辑的作品——工作源代码是一个符合高度发展的社区标准的社区项目。

当客户要求帮助制定编码标准时,我更愿意找到一个好的开源项目并提供一个简短的标准文档,上面写着“让它看起来像 xxx”。我用于 Java 风格的一个很好的例子是 Apache Ant项目。

每个人都有自己喜欢的开源示例项目。阅读一些真实世界的工作代码,然后选择一个最喜欢的。模仿那个项目。

于 2008-10-24T10:12:47.677 回答
1

我会使用谷歌。例如,要搜索 Java Coding Guidelines,我将使用此查询或在 Stack Overflow 上发帖,询问推荐的 Java 编码标准指南是什么。很难指出所有语言的单一来源。

我建议您为您的公司/项目选择一个并坚持下去,并确保它是一个好的标准。

于 2008-10-24T10:15:26.410 回答
1

如果您担心代码样式问题,我真的建议您阅读鲍勃叔叔的清洁代码。

于 2008-10-24T10:22:53.320 回答
1

有三个好地方可以看。

  1. 关于您使用的语言的热门书籍。
  2. 用您的语言编写的开源项目。
  3. 适用于您的语言的 Checkstyle 类型的实用程序。

如果您使用 Checkstyle 或 PMD 之类的工具,请注意它们执行的许多“规则”可能会引起争议。检查文档以找出需要警惕的规则可能会有所帮助。

于 2008-10-24T12:53:01.290 回答
1

Microsoft 有一个参考文档,其中包含他们的编码约定,即使您不使用 C#,也可能很有用。除了风格和基本约定之外,这里其他人推荐的最佳实践书籍,如Clean Code,对于创建可维护、可读的代码,这对代码库的未来维护者来说是有意义的,是必不可少的读物。

如果您使用的是 Visual Studio(和其他一些现代 IDE),则与推荐约定的基本不一致会自动加下划线(在最新版本的 VS 中建议悬停)。在 VS 中,如果您的团队想要使用不同的标准,只需打开项目属性并更改“代码分析”的设置(最后一个左侧菜单项)。更多内容:使用规则集对代码分析规则进行分组

于 2017-10-30T16:11:11.527 回答
0

大家好,美好的一天

好吧,我必须说这取决于您是为公司工作还是为您工作;)

如果你为一家公司工作,你必须接受命名风格和其他规则

而对你来说,你只需要建立一种风格,让包括你自己在内的每个人都能立即理解什么和如何

括号和其他是你的方式

但正如你所说,有不同的语言,所以它们有自己的规则

就像 Mnementh 说的,每个团队都有自己的编码方式,可能是严格的,也可能是自由的

仅此而已....再见

于 2008-10-24T10:12:09.910 回答
0

C 和 C++ 风格指南,一个简短的页面链接到风格指南、编码规则和来自 USENET 的讨论,由 Christopher Lott 维护。

于 2009-05-19T18:18:07.610 回答
0

如果您是PHP开发人员,请不要错过这两个指南:

于 2011-06-17T12:01:54.767 回答