问题标签 [coding-style]

我一直在进行大规模的代码审查，我注意到的一个模式是：

这不是我会这样做的方式，当我知道它是什么时，我会返回该值。这两种模式哪个更正确？

我强调逻辑似乎总是这样结构化，使得返回值仅在一个地方分配，并且在分配后不执行任何代码。

Java 有一些非常好的开源静态分析工具，例如FindBugs、Checkstyle和PMD。这些工具易于使用，非常有用，可在多个操作系统上运行并且免费。

提供商业 C++ 静态分析产品。虽然拥有这样的产品很棒，但对于学生来说成本太高了，而且通常很难获得试用版。

另一种方法是找到可以在多个平台（Windows 和 Unix）上运行的开源 C++ 静态分析工具。通过使用开源工具，可以对其进行修改以满足某些需求。找到这些工具并非易事。

以下是其他人发现或建议的 C++ 静态分析工具的简短列表。

• C++ 检查http://sf.net/projects/cppcheck/
• Oink http://danielwilkerson.com/oink/index.html
• C 和 C++ 代码计数器http://sourceforge.net/projects/cccc/
• 夹板（来自答案）
• Mozilla 的猪肉（来自答案）（现在是 Oink 的一部分）
• Mozilla 的 Dehydra（来自答案）
• 使用-Weffc++GNU g++ 的选项（来自答案）

还有哪些其他任何人都知道并可以推荐的便携式开源 C++ 静态分析工具？

一些相关链接。

• http://en.wikipedia.org/wiki/List_of_tools_for_static_code_analysis
• http://www.chris-lott.org/resources/cmetrics/
• 根据一组编码标准检查 C/C++ 源代码的免费工具？
• http://spinroot.com/static/
• 选择静态代码分析工具

我听说汽车行业有一种叫做 MISRA C 的东西。

其他高可靠性/可用性/安全性行业的相关标准是什么，例如

• 空间
• 飞机
• 银行/金融
• 汽车
• 医疗的
• 国防/军事
• ？？？

-亚当

我已经看过其他问题，但我仍然对涵盖该主题的方式不满意。

我想在代码检查中提取一个精简的列表来检查注释。

我相信人们会说一些只会互相抵消的话。但是，嘿，也许我们可以为每个营地建立一个清单。对于那些根本不发表评论的人来说，这份名单会很短:)

我们都知道，注释我们的代码是编码风格的重要组成部分，它可以让下一个出现的人，甚至是我们自己在 6 个月左右的时间内都能理解我们的代码。

但是，有时评论并不能解决问题。我不是在谈论明显的笑话或发泄的挫败感，我说的是似乎试图解释的评论，但做得很糟糕，他们可能不在那里。太短、太神秘或完全错误的评论。

作为一个警示故事，您能否分享您所看到的确实很糟糕的东西，如果不是很明显，请显示它所指的代码并指出它有什么问题？那里应该放什么？

也可以看看：

• 何时不评论您的代码
• 你觉得你的评论怎么样？（最佳实践）
• 你在源代码中遇到过的最好的注释是什么？