转载

每一个程序员要遵守的一些优秀编程风格

英文原文： Want A Proper Programming Style? Here Are Rules You Need To Follow

无论你是业余的还是专业的程序员，正确的编程风格，不但有助于提升软件产品的功能，还可以明显减少软件灾难的产生。今天，我们就来探讨一下有助于我们获取更佳编程风格的一些最好的规则。

代码的可读性至上

代码要能可阅读和可理解，就需要格式化成一致的方式。对函数和变量的命名应有意义，注释的表达应该简洁而准确。并且，准确地记录代码中所有棘手的部分是十分重要的。你必须清楚软件程序为什么能工作以及为什么能在所有可能的情况下顺利工作的原因。

遵循正确的命名约定是必须的

当需要给类、函数和变量命名时，你需要遵循以下指南：

确保特定类名的第一个字母大写；
使用大小写分离多个单词的命名；
大写常数名，并使用下划线分离单词；
确保特定功能和变量名的第一个字母小写；
注意正确使用缩写。例如，用 max 而不用 maximum。

必要时可使用空格

虽然空格对编译器是没有意义的，但是可用于提高代码的可读性。举个例子，你可以在函数间留三个空行。你还可以在函数内使用单独的空行用于分离关键的代码段。

确保代码有一定的可维护性

我们需要确保写出来的代码，换成另一个程序员来调整功能、修复 bug，也是明确易懂的。要将函数中关键值用常量来标记，这样我们就可以随时根据需要来改变这些常量值。总而言之，代码必须坚固，能够处理任何类型的输入，然后在不崩溃的前提下，提供预期结果。

注释必须易于理解

注释应该是有意义的，能够清晰地解释所有关于软件程序的内容。注释的数量多少无所谓，质量才是关键。你需要使用/ *注释* /的风格来写注释，以确保位于每个源文件的顶部。此外，你也可以选择在注释中包括你的名字，编写代码的日期，以及简明扼要地说明程序的实际用途。不过，你可以选择省略一些功能明显的注释。你需要遵循的行内注释格式为//注释。

正确使用函数

每一个函数所包含的代码片段，必须既短又能够完成特定的任务。不妨将函数当作是“黑盒子”——独立，又可以有效处理任何类型的输入。不要忘记这样一条经验规则——即所谓的“Ten Line Rule”，也就是说，一个函数，通常说来，如果超过 10 行，那就需要以最精炼的方式去简化。并且，任何重复性的代码片段都应该被设置为一个单独的函数。上述做法不但可缩短程序的长度，还能大大提高其可读性。