Java基础--------(1)注释
来源:互联网 发布:大淘客联盟与淘宝联盟 编辑:程序博客网 时间:2024/05/22 10:31
在Java的编写过程中我们需要对一些程序进行注释,除了自己方便阅读,更为别人更好理解自己的程序,所以我们需要进行一些注释,可以是编程思路或者是程序的作用,这样可以最大限度的提高团队开发合作效率,提高代码的可维护性。
一、注释格式:
1、单行注释:“//……”
注释规则:在代码中单起一行注释, 注释前最好有一行空行,并与其后的代码具有一样的缩进层级。如果单行无法完成,则应采用块注释。
2、多行注释:“/*……*/”
注释规则:注释若干行,通常用于提供文件、方法、数据结构等的意义与用途的说明,或者算法的描述。一般位于一个文件或者一个方法的前面,起到引导的作用,
3、文档注释:“/**……*/”
4、javadoc 注释标签语法
在Java中,比较特殊的是javadoc注释,包含在这部分中的注释可以通过javadoc命令来自动生成API文档。通过javadoc工具,可以保证程序代码和技术文档的同步。在修改了程序中的注释后,只需要通过javadoc,就可以方便地生成相应的技术文档。@author 对类的说明 标明开发该类模块的作者@version 对类的说明 标明该类模块的版本@see 对类、属性、方法的说明 参考转向,也就是相关主题@param 对方法的说明 对方法中某参数的说明@return 对方法的说明 对方法返回值的说明@exception 对方法的说明 对方法可能抛出的异常进行说明
二、文档注释位置
1.类注释。类注释用于说明整个类的功能、特性等,它应该放在所有的“import”语句之后,在class定义之前。这个规则也适用于接口(interface)注释。2.方法注释。方法注释用来说明方法的定义,比如,方法的参数、返回值及说明方法的作用等。方法注释应该放在它所描述的方法定义前面。3.属性注释。默认情况下,javadoc只对公有(public)属性和受保护属性(protected)产生文档——通常是静态常量。4.包注释。类、方法、属性的注释都直接放到Java的源文件中,而对于包的注释,无法放到Java文件中去,只能通过在包对应的目录中添加一个package.html的文件来达到这个目的。当生成HTML文件时,package.html文件的<BODY>和</BODY>部分的内容将会被提取出来当做包的说明。关于包注释,后面还会有更进一步的解释。5.概要注释。除了包注释外,还有一种类型的文档无法从Java源文件中提取,就是对所有类文件提供概要说明的文件。同样的,也可以为这类注释单独新建一个HTML文件,这个文件的名字为“overview.html”,它的<BODY>和</BODY>标记之间的内容都会被提取。
阅读全文
0 0
- Java基础--------(1)注释
- java基础(1)文档注释
- Java基础(六)----注释 annotation
- java基础之 注释
- JAVA基础之注释
- Java基础--环境变量、注释~
- java基础之注释
- java基础之一注释
- Java基础---如何在Java中注释(十)
- Java基础——注释
- java基础第一章_注释
- 黑马程序员----Java语言基础1(关键字、标识符、注释、常量和变量、运算符)
- Java基础语法(1)----关键字、标示符、注释、常量、进制、变量、运算符
- 01_Java基础_第1天(Java概述、环境变量、注释、关键字、标识符、常量)
- Java基础:Day02笔记内容 (常量、注释、变量)
- Java语言基础(三)—— 注释
- Java基础(二) 注释和基本数据类型
- Java基础{java概述,环境变量,注释}
- 正则表达式 → AppValidationMgr
- Android7.0中文文档(API)-- ResourceCursorTreeAdapter
- 使用原生的ajax如何去提交json格式的数据
- Oracle将字符串转为数字
- 面试题11:数值的整数次方
- Java基础--------(1)注释
- 怎么原样式转载其他人博客
- 安卓隐式intent(打电话,浏览器)
- Wifi管理工具类 → AppWifiHelperMgr
- java poi 导出带下拉的excel
- 使用Netty构建一个多线程服务器与客户端
- nt驱动1
- 机器学习笔记 001
- 类型转换类 → ConvertUtils