优雅的程序员

-------------------------------------------------------------------------------------------------------------html

先后经历了两家公司,再加上本身在学校中写程序的经历,简单说一下好的程序风格!程序员

一、注释多线程

  该有的注释必定要有,那么那些地方该有注释呢?框架

  答:程序头函数

    【功能描述】【建立人】【建立日期】【备注】等等post

    变量  加密

      //每个变量必定要有注释  说明这个变量的意义  固然,像循环中的 i  k这种能够没有吧!spa

      //另外 多提一句,一个变量最好只有一个意义  不要有多个意义  eg: sign = MD5(sign);  这样就很差,sign 一下子是加密前的 一会是加密后的 ,容易乱  能够这样写线程

      //sign = MD5(sign_src);设计

    函数说明

      //函数说明必定要有  最起码应该有 【函数功能】【入参】【出参】的说明  固然还能够有 【修改人】【日期】等

二、命名

  关于命名 涉及到 类、函数、变量、包(Java中)的命名;

   首先 第一大禁忌:不能够用汉语拼音,,,

   就我的而言,没见过用哪一个上档次的程序 是用的拼音进行命名的;其次,实在以为太low了,身为程序员,不免要看一些英文资料,因此用英文命名 不该该有什么难度,这不    还有有道呢么?

   第二,命名要有意义  

   名字和其所表明的含义要一致,例如:巷道 lane或者 tunnel 均可以(最好仍是用tunnel  由于 lane通常指隧道);别随便来一个单词  

   第三 命名要统一

   什么意思呢?还拿巷道举例,一样是巷道,在这个函数里用 tunnel  而在另外一个函数里 用lane这就很差,最好是同一块儿来,都用一个,加强程序的易读性;还有对于一个团    队来讲也应该是同一的,不该该这我的用lane  另外一个用tunnel;都统一块儿来。

   补充一小点

     对于函数的入参 能够在形参前面同一加上 in_   对于出参,能够统一加上 out_    

 三、格式

  这里说的格式指的是该对齐的地方要对齐,这一点很容易作到,由于通常的IDE都会自动对齐的,例如 VS里面 快捷键 Ctrl+k+d  自动对齐;

   实际上,只有在对齐的前提下,程序的结构才能显得清晰明了

四、异常处理

   尽可能避免出现  程序没有处理,而交由语言或者平台自己去处理的异常状况发生;当程序崩溃时,哪怕不知道缘由,最好的作法是捕获异常,给用户一个提示,而后退出!

  因此,最好每一句话都放在try{}catch(e){}  里面;尤为是 JS,由于一旦某个地方异常,没有处理  后面语句就不执行了 ;

五、尽可能避免使用全局变量

   尽可能避免使用全局变量,由于一个全局变量可能贯穿程序的始终,会大大的增强程序的耦合性,尤为是在多线程中;并且,若是再函数中使用了这个全局变量,那么这个函数脱离了这个程序便不能独立使用。

六、尽可能避免重复代码

  对于重复代码,维护和修改的工做量都是很大的,并且容易出bug。

七、函数的独立性与完整性

  完成一个函数的编写以后,其功能要与设计时的功能一致,不要依赖于外部调用;如 一段登陆代码,最终返回的结果就应该是登陆成功 或者 登陆失败,不要依靠外部代码判断是否登陆成功。

 

其余:写代码以前,能够尝试着先写框架,而后去填充实体代码;写框架的时候要作好功能的分割;

转载于:https://www.cnblogs.com/tengpan-cn/p/4764673.html