良好的编程习惯

来源:互联网 发布:sql sa登陆 18456 编辑:程序博客网 时间:2024/05/18 02:30
1.避免使用大文件,如果一个文件里的代码超过300~400行,必须考虑将代码分开到不同类中。 
2.避免写太长的方法,一个典型的方法代码在1~30行之间。如果一个方法发代码超过30行,应该考虑将其分解为不同的方法。 
3.方法名需能看出它作什么,别使用会引起误解的名字。如果名字一目了然,就无需用文档来解释方法的功能了。
4. 一个方法只完成一个任务,不要把多个任务组合到一个方法中,即使那些任务非常小。 
5.别在程序中使用固定数值,用常量代替。
6.别用字符串常数,尽量用资源文件。 
7.避免使用很多成员变量,声明局部变量,并传递给方法。 
8.不要在方法间共享成员变量,如果在几个方法间共享一个成员变量,那就很难知道是哪个方法在什么时候修改了它的值。必要时使用enum,别用数字或字符串来指示离散值。
9.别把成员变量声明为 public或 protected。都声明为private 而使用 public/protected的Properties。
10.不在代码中使用具体的路径和驱动器名,使用相对路径,并使路径可编程。永远别设想你的代码是在"C:"盘运行。你不会知道,一些用户在网络或"Z:"盘运行程序。 
11.应用程序启动时作些“自检”并确保所需文件和附件在指定的位置。必要时检查数据库连接,出现任何问题给用户一个友好的提示。 
12.如果需要的配置文件找不到,应用程序需能自己创建使用默认值。如果在配置文件中发现错误值,应用程序要抛出错误,给出提示消息告诉用户正确值。错误消息需能帮助用户解决问题。
13.注释:别每行代码,每个声明的变量都做注释。在需要的地方注释。可读性强的代码需要很少的注释,如果所有的变量和方法的命名都很有意义,会使代码可读性很强并无需太多注释。行数不多的注释会使代码看起来优雅。如果因为某种原因使用了复杂艰涩的原理,必须为程序配备良好的文档和详细的注释。对注释做拼写检查,保证语法和标点符号的正确使用。
 

 
原创粉丝点击