老生常谈的代码规范

前言

从非常早的时候,学习VB的时候我们就涉及到了代码规范的问题,那个时候大家更多的时候注意控件命名和注释的规范。而现在随着我们学习的深入,代码编码规范越发地尤为重要。

那我们为什么需要统一代码编码的规范呢?

第一:规范的代码可以促进团队合作
第二:规范的代码可以减少bug处理
第三:可以降低我们项目的维护成本
第四:有利于代码审查
第五:有利于自身的成长
有一句话说的非常好,我们写的代码自己能看懂没什么,可以让其他人都看懂才是真的棒。

自己说设计到的代码规范带来的便利

机房合作的时候,我们的每一个方法和变量名还有数据库的名字都采用了规范的命名和注释。一开始函数是没有的,只是加了一个单行注释,而不是函数标准注释,导致使用函数传参等不是很便利。加了正规的注释之后非常便利。

基本的代码规范举例

1、类:
① 创建时,文件开头写清楚作者、日期、版本号等
② 类名要写清楚。命名要见名知意。
③ 类中的属性名字最好以名词或形容词。建议使用Pascal大小写命名法。不要使用缩写
④ 类和接口直接的实现关系,可以在类名中体现出来。
⑤ 类中的字段最好使用private、或者protected。

2、方法:
① 方法加注释,写清楚方法的用途,参数的说明,以及返回值的说明
② 方法命名以及参数命名都要采用合适的命名。建议使用Camel大小写命名

发布了110 篇原创文章 · 获赞 21 · 访问量 1万+

猜你喜欢

转载自blog.csdn.net/make_1998/article/details/103841319