编写清晰整洁的代码

         编写清晰整洁的代码

一、编程技巧
 
   给代码加上注释
   给代码分段
   使用空白
   遵循30（10）秒法则
   说明消息发送的顺序
   写短小单独的命令行

三、重要注意事项

   面向人而不是面向机器编程。
   首先设计，然后编写代码。
   一小步一小步地开发
   让代码简洁
   学习常用的模式、反模式和代码模式

四、命名约定
   使用可以准确说明变量/字段/类的完整的英文描述符。
   采用该领域的术语。
   采用大小写混合，提高名字的可读性。
   尽量少用缩写，但如果一定要使用，就要谨慎地使用 （I18N国际信息化）
   避免使用长名字（最好不超过15个字母）。
   避免使用相似或者仅在大小写上有区别的名字。
   避免使用下划线作为名字的首末字母。

五、注释约定
  
    注释应该增加代码的清晰度。
    如果你的程序不值得注释，那么他也很可能也不值得运行。
    避免使用装饰性内容，也就是说，不要使用象广告横幅那样的注释语句。
    保持注释的简洁。最好的注释应该是简单明了的注释。
    先写注释，后写代码。写代码注释的最好方法是在写代码之前就写注释。
    注释信息不仅要包括代码的功能，还应给出原因。

 

评论

2 楼 xmx0632 2008-06-28  

特别讨厌看到一段段被注释掉,而且没一点说明为啥注释掉而不删除的代码.注释掉了就不用了嘛,干嘛不删了?难道连个最起码的版本控制工具都没有?

1 楼 shxiao 2008-06-28  

如果你的程序不值得注释，那么他也很可能也不值得运行---狂晕

特别讨厌注释n多的代码，尤其是代码里面