写在前面,本人初次整理关于java的有关概念,难免有误和不足之处,还望能得到大家多多指正,一起进步。
1.注释
1.什么是注释?
注释是解释说明程序的文字分类。注释是程序员对源代码的类,方法,属性等做的一些记忆或提示性描述(比如这个方法是做什么用的),是给人来看的。
2.单行注释
用//来表示:可以写在任何一行代码前。
3.多行注释
用/* */来表示:可以写在任何一行代码前,不能和单行注释嵌套使用。
4.文档注释
用/** */来表示:只能写在类或成员之前,编译时可以生成API文档。
一、注释
虽然注解、注释只相差一个字,但是用法就差异很大。
还是那句话, 注解给编译器看, 注释是给人看的。
基于此的话, 对于一个方法来说:
1. 把这个方法的作用, 输入,输出描述清楚就可以了,更多的可以加上一些作者呀,版本呀这样一些信息
2. 注释编排的美观一些
做到这两点应该就可以了。 举个例子:
/******************************************************************************* * NAME: usage * DESCRIPTION: XXX * ARGUMENTS: N/A * RETURN: * AUTHOR: oscar999 * VERSION: V0.1 *******************************************************************************/
看上去这是一个不错的注释^^.
但是对于Java 语言来说, 注释被赋予了更多的功能。 就是你可以使用javadoc 这个功能把代码中的注释导出到 html 的文件中。
如果你的代码是共用性很高的代码的话, 这份文档就是一份API的参考文档, 类似Java API.
所以, 要产生出这样的文档,就要遵循java 定义的一些注释规范, 才能产生出规范的文档出来。
二、Java 类方法的标准注释
还是从类的方法的注释说起。
/** * Read a line of text. A line is considered to be terminated by any one * of a line feed ('\n'), a carriage return ('\r'), or a carriage return * followed