个人编码规范

时间:2021-02-10 22:43:08

这里所列的编码规范都是我自己的一些编码习惯,同时参考了其他的一些编码规范而总结出的较常用一些规范。供参考:

1、一个类文件中只能包含一个类、枚举。
2、所有public修饰的字段、属性、方法、类等必须作详细的注释。
3、复杂的业务逻辑处应该注释清楚处理的方式及逻辑,算法的说明。
4、一个方法只做一件事(单一职责原则),不要一个方法内实现多种功能。
5、每个方法的方法体不能超过50行。
6、循环体内不能声明变量。
7、应该对每个方法的入参作判断(私有方法有时视具体情况,可不判断,但建议还是判断一下较好)。
8、常量值尽量声明为const类型,并大写变量名,单词间用下划线连接。

(暂时先列这些,后续慢慢补充)