代码编写注意事项

目录

规范性

包名

类名、接口名

变量名、方法名

常量名

可读性

见名知意

命名及长度

健壮性

---

        合理合规的代码会给你的程序赋予更强的生命力，通过工作中遇到的问题，总结出以下几点代码编写的建议。

        编写代码应该遵循以下几大规则：【规范性、可读性、健壮性】

规范性

        规范编写代码可以让你的得代码更加的美观，一般都要求遵循【驼峰命名法】，简单来说就是适当的大小写交叉更加方便的区分变量、方法、参数、接口、类型等信息。

包名

        多单词组成时所有字母都小写：【testapp】

类名、接口名

        多单词组成时，所有单词的首字母大写：【TestAppInterface】

变量名、方法名

        多单词组成时，第一个单词首字母小写，第二个单词开始每个单词首字母大写：【sSql】

常量名

        所有字母都大写。多单词时每个单词用下划线连接：【SUNDAY】

可读性

见名知意

        在起名字时，为了提高阅读性，要尽量有意义，即看见这个名字就知道是什么类型的参数，代表什么含义。

        例如【sSql】含义：s代表为 String 类型变量，Sql 代表即将执行的 SQL 语句。

命名及长度

        同时各种标识符的长度不建议多于 30 字符，否则阅读体验可能较差，超过 45 字符，就会很痛苦。并且额外需要注意的是，不要使用拼音！不要使用拼音！不要使用拼音！

        当你随便对一个标识符命名时，当时你可能看得懂，一段时间之后，自己可能都不知道当时定义的这个是什么，所以在必要的部分加上注释。方便自己方便他人。

        不写注释，随便命名的代码，会被我们友好的称为“shi山”。

        部分语言，例如 java 采用 unicode 字符集，因此标识符也可以使用汉字声明，不建议使用。

健壮性

        健壮性大致意思是，你编写的代码在部分极端的情况下依旧能够稳定的运行。

        做好以上两点之后，就可以编写自己的代码，实现自己需要的功能。在编写逻辑的时候，除了基本功能实现之外，我们应该额外考虑边界条件.

        这是各种算法题中经常出现的问题，同时也是工程中极易出现问题的部分，写这篇文章的原因就是今天我也犯了这样的错误，导致出现异常，可以说是为了这碟醋才包的这碗饺子。

        相信在学校的时候，老师们一定举过这个例子，在程序中进行数学运算时，当分母出现 0 程序会怎么样，这就是一种边界问题的考量。类似的例子还有很多，例如数组角标越界、SQL 语法错误、异常未及时抛出/处理等等。

        今天我就遇到了类似的问题，在 C# 的代码中，我调用 EDC 接口传来的数据，因为未考虑接收来的数据全为 null 的情况，直接对 Tables[0] 进行遍历，导致已经上线的功能出现异常。应该在遍历之前对 DateSet 的内容进行检查，当 DateSet 不为 null 的时候再进行相关的处理。

// 设置数据集存储 EDC 数据
DataSet dataSet = GetEDC.GetEDCData(param01, param02);
for (int i = 0; i < dataSet.Tables[0].Rows.Count; i++){...}

         希望以此来告诫自己，不论何时，一定要慎重的考虑好边界条件，没有人不写 bug，没有人不犯错误，我只希望以后类似的错误可以减少乃至杜绝。