程序设计和编码规范的一些戳见

程序设计和编码规范的一些戳见

前言

下面是一些个人在实际项目中遇到的问题!所以产生了一些个人戳见,在这拿出来分享!希望大家不要吝啬,把想法说出来供大家参考和学习!

多余的编码

Ok,字典码遍历!这种处理随处可见,只为一个处理字段,写了一大堆消耗性能的代码!如果在DB中添加这么一个处理后的字段,只要在插入数据时稍作处理,那么可为前台编写省去了一部分编程工作,也省去了不必要的性能消耗问题!
还有一个问题,就是多表关联!主键表引用外键表,存入外键表唯一标识!在前台使用时不得不根据外键标识去获取其他字段(名称)!如果外键表字段不常更新,我还是建议用以上那种方法!

糟糕的注释

每个方法都含有注释!这很“规范”!经常跟同事谈起注释,没有注释,可能别人很难去更改你的代码,更可能是无从下手!于是注释到处可见,一个局部或全局变量或函数或类都会强制冠上注释!不得不说这很糟糕!
如果一个函数有注释,我第一眼肯定是看函数的注释(好像意味它能解释函数,不知道你们是不是!),但是这个注释是画蛇添足,因为方法名已经足够有解释力度了!多余的是在注释浪费程序员的生命!

标准的函数匹配注释!

程序员不得不查看方法后才明白!验证数据顺带初始化模型!

这时不需要有任何注释,干净整洁!
与其思考如何写有解释性的注释,不如花时间思考如何命名更具权威的函数或变量名!

统一编码格式

请不要把一个函数调用的变量声明在老远的地方,在寻找的时候还需要滚动着滑轮!
同样,一个函数调用另一个函数,也请不要把哥俩分开!程序员也希望就在附近能找到被调用的那个函数,而不是又拽着滑轮!
也不要让一行代码请不要让它超出你的视野!换行或者拆分重构!尽可能的不要用鼠标拖拽横条去查看后面的代码!

在使用一个全局变量时,通常会把它声明在类的顶端!不过在这种情况下,一个类文件的代码超过三千多行~(这维护简直就是天荒夜谈,在这就只谈全局变量!)。还是给这个全局变量添加一个三撇函数注释比较好,可能在调用的时候,你忘记了它的用途或者默认值或一些其它信息,使之可读性增强!读你代码的人也不用跑到顶端去查看了!

凡是程序,都应该保持从上而下的习性!从上而下的业务所以从上而下的编码,不要写的毫无格式规范,让读者反感!

 
 
分类: 理论总结
原文地址:https://www.cnblogs.com/Leo_wl/p/3179372.html