欢迎来到天天文库
浏览记录
ID:14887727
大小:1.17 MB
页数:4页
时间:2018-07-30
《android&java代码注释标准规范》由会员上传分享,免费在线阅读,更多相关内容在行业资料-天天文库。
1、Android/Java代码注释标准规范(软件技术系徐铁强原创)版权所有谢绝转载1、文件头注释每一个文件的文件头都必须做文件头注释。文件头注释范例如下:2、方法头注释每一个成员方法(包括自定义成员方法、覆盖方法、属性方法)的方法头都必须做方法头注释。自定义成员方法注释范例如下:覆盖(重写)成员方法注释范例如下:属性getter和setter成员方法注释范例如下:1、块注释在实现一段阶段性功能的代码前做块注释。块注释的注释范例如下:1、变量注释所有的成员变量和大多数局部变量在声明时都需要为其做功能注释。成员变量注释
2、的注释范例如下:局部变量注释的注释范例如下:1、语句注释在关键语句的右侧要做单条语句注释。语句注释的注释范例如下:2、有关注释的其它说明(1)文件头和方法头注释应该使用/**/形式,变量注释和语句注释应该使用//形式,块注释应尽量使用//形式,当文字较长(单屏横向不能显示完全)时块注释也可以使用/**/形式;(2)注释量必须不少于代码总量的三分之一;
此文档下载收益归作者所有