程序员最讨厌的两件事,自己加注释和别人不加注释。
现在公司的上司比较反对注释,我觉得对,注释的目的是解释说明,可是项目总要改,有人,改了方法,不改注释,最后驴唇不对马嘴,而后来的程序员看了注释不看方法,最后缘木求鱼,乱七八糟。上司说:名字要见名知意,不怕名字长,但是要写清楚,注释加不加都行。
java注释有三种:单行注释,多行注释,文档注释,前两种是继承了 c,c++
单行注释: // 注释内容
多行注释:/*... 注释内容....*/
/*... 注释内容....
*... 注释内容....
* ... 注释内容....
*/
/* */为注释的开始和结束,至于中间的*****,只是为了美观,格式整齐
文档注释:/**.. 注释内容....*/
这种注释可以用来自动地生成文档。在JDK中有个javadoc的工具,可以由源文件生成一个HTML文档,可以使用web浏览器查看。使用这种方式注释源文件的内容,显得很专业,并且可以随着源文件的保存而保存起来。也就是说,当修改源文件时,也可能对这个源代码的需求等一些注释性的文字进行修改,那么,这时候可以将源代码和文档一同保存,而不用再另外创建一个文档。javac只能为public和protected成员进行文档注释。rivate和friendly会被忽略掉,因为后两者根本就不能在文件之外使用,所以也没必要提供注释
文档注释可以加在 类,属性,方法前一行。。
标签注释,标签注释,我自己很少用,想看示例的话,请打开lang包,里边很全面,也很规范