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

例如 C Kernighan 和 Ritchie 的书 C 编程语言 和莱纳斯·托瓦尔兹的 Linux 内核编码风格指南 或者 Google 的 C++ 风格指南 至少对于 Perl 来说 perlstyle - Perl 风格指南.

编辑:也许我应该问“如何在编码风格方面取得良好的开端”。

有帮助吗?

解决方案

我不会对这种风格指南给予太多关注。它们是一个良好的开端,但最终您或您的团队将开发自己的编码风格。

编辑:Rob Kam发表评论,他希望了解更多有关这些“起始约定”的信息。

这是一个好点。但是,大多数情况下,您将加入现有项目,开源项目或商业项目,并且在其上工作的人员已经拥有代码约定。在公司中可能已存在代码约定。如果你开始一个新项目,先从你之前做过的另一个项目的约定开始。

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

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

其他提示

比书更好的方法是找到您首选语言的开源代码。

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

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

每个人都有自己喜欢的开源示例项目。阅读一些真实的,有效的代码,并选择一个喜欢的。模仿该项目。

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

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

我真的建议您阅读叔叔鲍勃的清洁代码关注代码风格问题。

有三个好看的地方。

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

如果你使用像Checkstyle或PMD这样的工具,请注意许多“规则”。他们强制执行可能会引起争议。 查看文档可能有助于找出哪些规则需要警惕。

Microsoft有一个参考文档及其编码约定,即使您不使用C#,也可能有用。除了风格和基本惯例之外,其他人推荐的最佳实践书籍,如清洁代码,是创建可维护,可读代码的基本读物,对代码库的未来维护者有意义。

如果您正在使用Visual Studio(以及其他一些现代IDE),则会自动强调与推荐约定的基本不一致性(有关在最新版本的VS中悬停的建议)。在VS中,如果您的团队想要使用不同的标准,只需打开项目属性并更改“代码分析”的设置即可。 (最后左手菜单项)。 更多信息:使用规则集对代码分析规则进行分组

你好,大家好日子

我必须说这取决于 这取决于你是否为公司工作 或者如果你为你工作;)

如果您在公司工作,您可以接受命名方式和其他规则

对你而言,你只需要建立一种风格,包括你自己在内的每个人都可以立即了解什么以及如何

括号和其他是你的方式

但正如你所说,有个别语言,所以他们有自己的规则

和Mnementh一样,每个团队都有一种编码可能是严格或自由的方式

多数民众赞成 没有...... 再见

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

如果你是一个 PHP 开发者不要错过这两本指南:

许可以下: CC-BY-SA归因
不隶属于 StackOverflow
scroll top