注释格式

PHP:

1、用 // 作为单行注释。

2、用 # 作为单行注释。

3、用 /*  * /多行注释。

HTML:

<!--   -->

CSS:

/*  */

JAVASCRIPT:

1、用//作为单行注释。

2、用 /*  * /多行注释。

 JAVA:

1、//单行注释

2、/*  多行注释  */

3、/**   文档注释(多行)   */

可以通过javadoc命令从文档注释中提取内容,生成程序的API帮助文档。

如:javadoc  -d  doc  Demo03.java  得到结果之后,进入你的java文件夹,找到index.html并用浏览器打开,就可以得到你自己生成的API文档了。

使用文档注释时还可以使用 javadoc 标记,生成更详细的文档信息:

       @author 标明开发该类模块的作者

       @version 标明该类模块的版本

       @see 参考转向,也就是相关主题

       @param 对方法中某参数的说明

       @return 对方法返回值的说明

       @exception 对方法可能抛出的异常进行说明

原文地址:https://www.cnblogs.com/yaohunzhanyue/p/5457819.html