代码命名规则及代码编程规范

分手后的思念是犯贱 2022-08-07 10:54 222阅读 0赞

转载自：百科

骆驼式命名法（Camel-Case）是电脑程式编写时的一套命名规则（惯例）。

骆驼式命名法就是当变量名或函式名是由一个或多个单字连结在一起，而构成的唯一识别字时，第一个单词以小写字母开始；第二个单词的首字母大写或每一个单词的首字母都采用大写字母，例如：myFirstName、myLastName，这样的变量名看上去就像骆驼峰一样此起彼伏，故得名。

骆驼式命名法（Camel-Case）一词来自 Perl 语言中普遍使用的大小写混合格式，而 Larry Wall 等人所著的畅销书《Programming Perl》（O'Reilly 出版）的封面图片正是一匹骆驼。

骆驼式命名法的命名规则可视为一种惯例，并无绝对与强制，为的是增加识别和可读性。

小驼峰法

变量一般用小驼峰法标识。驼峰法的意思是：除第一个单词之外，其他单词首字母大写。譬如

int myStudentCount;

变量myStudentCount第一个单词是全部小写，后面的单词首字母大写。

大驼峰法

相比小驼峰法，大驼峰法把第一个单词的首字母也大写了。常用于类名，函数名，属性，命名空间。譬如

public class DataBaseUser;

以下转自：http://wtoutiao.com/p/df2MR8.html

代码的可读性至上

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

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

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

1.确保特定类名的第一个字母大写；

2.使用大小写分离多个单词的命名；

3.大写常数名，并使用下划线分离单词；

4.确保特定功能和变量名的第一个字母小写；

5.注意正确使用缩写。例如，用max而不用maximum。

必要时可使用空格

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

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

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

注释必须易于理解

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

正确使用函数

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

整齐的代码缩进

缩进在软件程序的流程控制上起着至关重要的作用。每一个新的while、for、if语句，以及switch结构，都需要缩进代码。这也可用于一行语句中括号已被省去的情况。例如，假设有if语句，那么相应else语句必须一齐缩进。