JavaSE概述
Java代码的注释
2021-05-19 511 2
简介 单行注释、多行注释、文档注释的使用和说明
A：嘿 //是什么意思啊？
B：嘿.
A：呃 我问你//是什么意思？
B：问吧.
A：我刚才不是问了么？
B：啊？
A：你再看看记录...
B：看完了.
A： ......所以//是啥？
B：所以什么？
A：你存心耍我呢吧？
B：没有啊 你想问什么？
……
不断循环之后， A一气之下和B绝交，自己苦学程序。
N年之后， A终于修成正果，回想起B，又把聊天记录翻出来看，这时，他突然发现B没有耍他……而他自己也不知道当年他问B的究竟是什么问题……
1. java规范的三种注释方式：
单行注释
多行注释
文档注释
2.单行注释和多行注释的作用：
① 对所写的程序进行解释说明，增强可读性。方便自己，方便别人（别写让别人讨厌的代码）
// 大多数程序员有个奇怪的现象： 自己不喜欢写文档、写代码不喜欢写注释， 总是嫌弃别人代码不写注释，嫌弃别人的项目没文档^_^
② 调试所写的代码
3. 特点：单行注释和多行注释，注释了的内容不参与编译。
换句话说，编译以后生成的.class结尾的字节码文件中不包含注释掉的信息
4. 多行注释不可以嵌套使用
public class HelloJava{ /* 多行注释： 如下的main方法是程序的入口！ main的格式是固定的！ */ public static void main(String[] args){ //单行注释：如下的语句表示输出到控制台 //System.out.println("Hello World!") System.out.println("Hello World!"); }} |
5. 文档注释
文档注释的使用：文档注释是java特有，注释内容可以被JDK提供的工具 javadoc 所解析，生成一套以网页文件形式体现的该程序的说明文档。
以/** 开头， 以 */ 结尾， 中间部分就是文档注释， 可以注释类，可以注释方法。
单行和多行注释是不能被javadoc命令解析的
/**文档注释@author ylaihui@version v1.0这是我的第一个java程序！！！*/public class HelloJava{ /** 如下的方式是main()，作用：程序的入口。 */ public static void main(String[] args){ //System.out.println("Hello World!") System.out.println("Hello World!"); }} |
将本机 E:\_temp 目录下的 HelloJava.java 使用javadoc命令进行文档注释的生成： -d 是指定生产文档的目录
E:\_temp>javadoc -d doc -author -version HelloJava.java
正在加载源文件HelloJava.java...
正在构造 Javadoc 信息...
正在创建目标目录: "doc\"
标准 Doclet 版本 1.8.0_151
正在构建所有程序包和类的树...
正在生成doc\HelloJava.html...
HelloJava.java:12: 警告: args没有 @param
public static void main(String[] args){
^
正在生成doc\package-frame.html...
正在生成doc\package-summary.html...
正在生成doc\package-tree.html...
正在生成doc\constant-values.html...
正在构建所有程序包和类的索引...
正在生成doc\overview-tree.html...
正在生成doc\index-all.html...
正在生成doc\deprecated-list.html...
正在构建所有类的索引...
正在生成doc\allclasses-frame.html...
正在生成doc\allclasses-noframe.html...
正在生成doc\index.html...
正在生成doc\help-doc.html...
1 个警告
生成的HTML、CSS、JS等文件
文章评论
标签云
联系我
- QQ: 361352119
- Email: lisimmy@sina.com
- 微信：
