资源描述:
《计算机,编程规范》由会员上传分享,免费在线阅读,更多相关内容在应用文档-天天文库。
1、计算机,编程规范 篇一:编程规范 1Java编程规范 排版 规则 规则1程序块要采用缩进风格编写,缩进的空格数为4个,不允许使用TAB缩进。(+) 说明:缩进使程序更易阅读,使用空格缩进可以适应不同操作系统与不同开发工具。 规则2分界符(如大括号?{?和?}?)应各独占一行,同时与引用它们的语句左对齐。在函数体 的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序 或者static、,synchronized等语句块中都要采用如上的缩进方式。(+) 示例:if(a>b){d
2、oStart();} 规则3较长的语句、表达式或参数(>80字符)要分成多行书写,长表达式要在低优先级操作 符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐, 语句可读。(+) 示例: if(()) { ("Sessiondestroyed,call-id" +().getCallId()); } 规则4不允许把多个短语句写在一行中,即一行只写一条语句(+) 说明:阅读代码更加清晰示例:如下例子不符合规范。Objecto=newObject();Objectb=null; 规则5if,
3、for,do,while,case,switch,default等语句自占一行,且if,for,do,while,switch等语句 的执行语句无论多少都要加括号{},case的执行语句中如果定义变量必须加括号{}。 (+) 说明:阅读代码更加清晰,减少错误产生示例:if(a>b) { doStart(); } casex:{inti=9;} 规则6相对独立的程序块之间、变量说明之后必须加空行。(+) 说明:阅读代码更加清晰 示例: if(a>b) { } //此处是空行 return; 规则7在两个以
4、上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者 前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如.),后不应加 空格。(+) 说明:阅读代码更加清晰 示例: if(a==b) { } a*=2; ();doStart(); 建议 建议1类属性和类方法不要交叉放置,不同存取范围的属性或者方法也尽量不要交叉放置。 (+) 格式: 类定义 { 类的公有属性定义 类的保护属性定义 类的私有属性定义 类的公有方法定义 类的保护方法定义 Page2,Total18 类
5、的私有方法定义 } 建议2修饰词按照指定顺序书写:[访问权限][static][final]。(+) 示例:publicstaticfinalStringstr=“abc”; 注释 规则 规则1源程序注释量必须在30%以上。(+) 说明:由于每个文件的代码注释不一定都可以达到30%,建议以一个系统内部模块作为单位进行检查 规则2包的注释:写入一个名为的HTML格式的说明文件放入包所在路径。包的 注释内容:简述本包的作用、详细描述本包的内容、产品模块名称和版本、公 司版权。(+) 说明:方便JavaDoc收集,方便
6、对包的了解 示例: com/huawei/iin/websmap/comm/ 一句话简述。 详细描述。 产品模块名称和版本 公司版权信息 示例: 为WEBSMAP提供通信类,上层业务使用本包的通信类与SMP-B进行通信。 详细描述。。。。。。。。 IINV100R001WEBSMAP (C)版权所有XX-XX华为技术有限公司 规则3类和接口的注释放在class或者interface关键字之前,import关键字之后。注 释主要是一句话功能简述与功能详细描述。
7、类注释使用“/***/”注释方式(+) Page3,Total18 说明:方便JavaDoc收集,没有import可放在package之后。注释可根据需要列出:作者、内容、功能、与其它类的关系等。功能详细描述部分说明该类或者接口的功能、作用、使用方法和注意事项,每次修改后增加作者和更新版本号和日期,@since表示从那个版本开始就有这个类或者接口,@deprecated表示不建议使用该类或者接口。 /** *〈一句话功能简述〉 *〈功能详细描述〉 *@author[作者](必须) *@see[相关类/方法](可选) *
8、@since[产品/模块版本](必须) *@deprecated(可选) */ 示例: package; import*; /** *LogManager类集中控制对日志读写的操作。 *全部为静态变量和静