java代码规范文档

原则：

注释形式统一

在整个应用程序中，使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同，按照这份规范写代码，不要试图在既成的规范系统中引入新的规范。

注释内容准确简洁

内容要简单、明了、含义准确，防止注释的多义性，错误的注释不但无益反而有害。

注释条件

基本注释

1.类（接口）的注释
2.构造函数的注释
3.方法的注释
4.全局变量的注释
5.字段/属性的注释

特殊必加注释

1.典型算法必须有注释
2.在代码不明晰处必须有注释
3.在代码修改处加上修改标识注释
4.在循环和逻辑分支组成的代码中加注释
5.为他人提供的接口必须加详细注释

注释格式

单行(single-line)注释：“//……”
块(block)注释：“/……/”
文档注释：“/*……/”
javadoc 注释标签语法

@author   对类的说明 标明开发该类模块的作者
@version   对类的说明 标明该类模块的版本
@see     对类、属性、方法的说明 参考转向，也就是相关主题
@param    对方法的说明 对方法中某参数的说明
@return   对方法的说明 对方法返回值的说明
@exception  对方法的说明 对方法可能抛出的异常进行说明

参考实例

类（接口）的注释

/*** @Description 类的描述* @author Administrator* @Time 2018-09-28* @version v1.1*/
public class testEwallet {}

构造函数的注释

    /*** @Description 构造方法描述* @param name* 按钮上显示文字*/public testEwallet(String name){}

方法注释

 /*** 为按钮添加颜色* @param color* 按钮的颜色* @return * @exception  (方法有异常的话加)* @author Administrator* @Time2012-11-20 15:02:29*/public voidaddColor(String color){}

全局变量注释

  /** The value is used for characterstorage. */private final char value[];

字段/属性注释

private String senderName;//发送人姓名private String title;//不能超过120个中文字符

java代码规范文档相关推荐

再读华为代码规范文档
两年前,开始编程前,读过华为代码规范文档,以后一直按该文档要求自己,两年后,再读,另有收获,发现这些问题,自己平时还是没有注意到. 1.关于函数使用: 1.1 接口函数参数在同一项目组应明确规定对接 ...
Java 开发规范文档
一 : 目的使本组织能以标准的,规范的方式设计和编码.通过建立编码规范,以使每个开发人员养成良好的编码风格和习惯:并以此形成开发小组编码约定,提高程序的可靠性,可读性,可修改性,可维护性和一致性等, ...
Python试题和规范文档
##试题: ###第一题: microbit和Arduino的区别 microbit:1.在线编程工具+本地编程工具,2.尺寸 43mm * 52mm,3.兼容电压:3V,4.带有模拟窗口,即使手上没 ...
microbit题目和规范文档
microbit题目和规范文档考试题目: 第一题:microbit和Arduino的区别第二题第三题:画流程图,当microbit晃动时,在LED点阵上显示1-6的随机数,当按钮b按下时,清空l ...
PBOC借记贷记应用终端规范文档，对名词解释
中国金融集成电路(IC)卡规范备注学习PBOC借记贷记应用终端规范文档,对名词解释备注一下. 应用 application 卡片和终端之间的应用协议和相关的数据集. 命令 command 终端 ...
还在手工制作APP规范文档？这款设计神器你不容错过
之前写了一些关于APP原型文档的文章:一款APP的交互文档从撰写到交付这次想写下关于APP设计规范文档的内容,规范文档这个东西,实际上大部分中小型公司没有这方面的需求,也没精力去制作这样一个系统性的 ...
C# 代码注释规范文档
C# 提供一种机制,使程序员可以使用含有 XML 文本的特殊注释语法为他们的代码编写文档.在源代码文件中,具有某种格式的注释可用于指导某个工具根据这些注释和它们后面的源代码元素生成 XML.使用这类语 ...
【代码规范】Web前端开发规范文档！！！
规范目的为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档. 本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发. 本文档如有不对或者不 ...
非主流架构师编写的架构规范文档
系统架构规范说明 foquanlin@163.com 2016年9月文档信息文档编号: 文档名称: 系统架构规范说明文档类别: 规范类密级: 普通版本信息: V0.5 建立日期: 2016 ...

java代码规范文档

java代码规范文档

原则：

注释形式统一

注释内容准确简洁

注释条件

基本注释

特殊必加注释

注释格式

参考实例

类（接口）的注释

构造函数的注释

方法注释

全局变量注释

字段/属性注释

java代码规范文档相关推荐

最新文章

热门文章