您好,登录后才能下订单哦!
请求超时!
请点击 重新获取二维码这篇文章主要为大家展示了“Java程序中Doc文档注释的方法是什么”,内容简而易懂,条理清晰,希望能够帮助大家解决疑惑,下面让小编带领大家一起研究并学习一下“Java程序中Doc文档注释的方法是什么”这篇文章吧。
我们知道,Java支持 3 种注释,分别是单行注释、多行注释和文档注释,我们来看看他们的样子
//单行注释
/*
多行注释
*/
/**
*@...
*....
*文档注释
*/
可能许多萌新不明白,写了这些注释有什么用呢?
其实是因为初学者的代码量少,没有注释也能快速查找、修改
当代码渐渐多了起来,注释就是一个好东西了,不仅是为了自己可以清晰明了看清代码,也是为了和你一起开发项目的成员一个方便
记住,改掉不写注释这种坏习惯!!!
那么,我们今天的主题来了,什么是Doc注释呢?
javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。
javadoc命令是用来生API文档的,使用方式:使用命令行在目标文件所在目录输入javadoc +文件名.java
这些复杂理论不必去纠结,要培养一种思想,去了解、去理解、去深入、去改变它,去懂得他,死死揪住理论是没有效果的!
我们写代码,都是有规范的,如果你写的代码可以运行,但是一团乱麻,是没人愿意使用的,因为难以维护,所以,代码不只是单纯的程序,在网络世界,我更愿意称之它为艺术品,需要你的精心镌刻
可能有人会说,不就是注释吗?这有什么的
不过,这个Doc注释可不与其他两个注释一样,注释也是存在规范的哦!
格式:
写在类上的文档标注一般分为三段:
第一段:概要描述,通常用一句或者一段话简要描述该类的作用,以英文句号作为结束
第二段:详细描述,通常用一段或者多段话来详细描述该类的作用,一般每段话都以英文句号作为结束
第三段:文档标注,用于标注作者、创建时间、参阅类等信息
这里我要扩展一点知识,我们的Doc注释可以使用Dos命令或者IDE工具生成一个Doc文档,这个文档是HTML语言来贯穿的,所以在注释里面可以搭配一些简单的HTML代码,比如下面这几个
换行<br>
分段<p>(写在段前)
放个实例样式图:
我们在写Doc注释时,/** 后直接回车,会自动生成后面的注释框架,和部分@符号,那么这些@符号有什么用呢?
标签 | 描述 | 示例 |
---|---|---|
@author | 标识一个类的作者,一般用于类注释 | @author description |
@deprecated | 指名一个过期的类或成员,表明该类或方法不建议使用 | @deprecated description |
{@docRoot} | 指明当前文档根目录的路径 | Directory Path |
@exception | 可能抛出异常的说明,一般用于方法注释 | @exception exception-name explanation |
{@inheritDoc} | 从直接父类继承的注释 | Inherits a comment from the immediate surperclass. |
{@link} | 插入一个到另一个主题的链接 | {@link name text} |
{@linkplain} | 插入一个到另一个主题的链接,但是该链接显示纯文本字体 | Inserts an in-line link to another topic. |
@param | 说明一个方法的参数,一般用于方法注释 | @param parameter-name explanation |
@return | 说明返回值类型,一般用于方法注释,不能出现再构造方法中 | @return explanation |
@see | 指定一个到另一个主题的链接 | @see anchor |
@serial | 说明一个序列化属性 | @serial description |
@serialData | 说明通过 writeObject() 和 writeExternal() 方法写的数据 | @serialData description |
@serialField | 说明一个 ObjectStreamField 组件 | @serialField name type description |
@since | 说明从哪个版本起开始有了这个函数 | @since release |
@throws | 和 @exception 标签一样. | The @throws tag has the same meaning as the @exception tag. |
{@value} | 显示常量的值,该常量必须是 static 属性。 | Displays the value of a constant, which must be a static field. |
@version | 指定类的版本,一般用于类注释 | @version info |
@后面我这里部分是英文,可以写中文,比如 @author 小简
我们上面说过,写了Doc注释,可以生成一个Doc文档,而且是HTML格式,那么我们怎么生成呢?
javadoc [options] [packagenames] [sourcefiles]
对格式的说明:
options
表示 Javadoc 命令的选项;
packagenames
表示包名;
sourcefiles
表示源文件名;
在 cmd(命令提示符)中输入javadoc -help
就可以看到 Javadoc 的用法和选项(前提是安装配置了JDK),下面列举 Javadoc 命令的常用选项:
名称 | 说明 |
---|---|
-public | 仅显示 public 类和成员 |
-protected | 显示 protected/public 类和成员(默认值) |
-package | 显示 package/protected/public 类和成员 |
-private | 显示所有类和成员 |
-d <directory> | 输出文件的目标目录 |
-version | 包含 @version 段 |
-author | 包含 @author 段 |
-splitindex | 将索引分为每个字母对应一个文件 |
-windowtitle <text> | 文档的浏览器窗口标题 |
用Doc生成又麻烦又慢,那还有没有其他方法呢?
我们可以用Eclipse或者IDEA生成,Eclipse我不怎么用,用IDEA给你们演示一下吧!
在工具这个里面的JavaDoc里面,进去后是这样的
输出目录必须选择,不然生成不了
注意了,因为Java的编码与IDEA的编码不一样,所以在其他命令形参栏目里面,要填写以下内容
-encoding utf8 -docencoding utf8 -charset utf8
生成之后,是这样的
以上是“Java程序中Doc文档注释的方法是什么”这篇文章的所有内容,感谢各位的阅读!相信大家都有了一定的了解,希望分享的内容对大家有所帮助,如果还想学习更多知识,欢迎关注亿速云行业资讯频道!
免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。
深圳SEO优化公司宝安网站关键词优化大浪百度竞价龙华关键词按天扣费坪山设计网站横岗网站改版松岗企业网站建设西乡网站优化按天计费双龙关键词按天计费深圳网站优化按天收费松岗seo网站推广平湖优秀网站设计龙华关键词排名坂田网站优化按天扣费横岗网站建设大鹏网站推广方案坪山外贸网站制作南澳网站关键词优化深圳网络广告推广龙岗关键词按天收费龙华网站开发木棉湾英文网站建设盐田设计网站深圳网站推广坑梓网络营销木棉湾网站推广西乡百度网站优化布吉推广网站永湖网站排名优化坂田网站优化按天扣费石岩SEO按效果付费歼20紧急升空逼退外机英媒称团队夜以继日筹划王妃复出草木蔓发 春山在望成都发生巨响 当地回应60岁老人炒菠菜未焯水致肾病恶化男子涉嫌走私被判11年却一天牢没坐劳斯莱斯右转逼停直行车网传落水者说“没让你救”系谣言广东通报13岁男孩性侵女童不予立案贵州小伙回应在美国卖三蹦子火了淀粉肠小王子日销售额涨超10倍有个姐真把千机伞做出来了近3万元金手镯仅含足金十克呼北高速交通事故已致14人死亡杨洋拄拐现身医院国产伟哥去年销售近13亿男子给前妻转账 现任妻子起诉要回新基金只募集到26元还是员工自购男孩疑遭霸凌 家长讨说法被踢出群充个话费竟沦为间接洗钱工具新的一天从800个哈欠开始单亲妈妈陷入热恋 14岁儿子报警#春分立蛋大挑战#中国投资客涌入日本东京买房两大学生合买彩票中奖一人不认账新加坡主帅:唯一目标击败中国队月嫂回应掌掴婴儿是在赶虫子19岁小伙救下5人后溺亡 多方发声清明节放假3天调休1天张家界的山上“长”满了韩国人?开封王婆为何火了主播靠辱骂母亲走红被批捕封号代拍被何赛飞拿着魔杖追着打阿根廷将发行1万与2万面值的纸币库克现身上海为江西彩礼“减负”的“试婚人”因自嘲式简历走红的教授更新简介殡仪馆花卉高于市场价3倍还重复用网友称在豆瓣酱里吃出老鼠头315晚会后胖东来又人满为患了网友建议重庆地铁不准乘客携带菜筐特朗普谈“凯特王妃P图照”罗斯否认插足凯特王妃婚姻青海通报栏杆断裂小学生跌落住进ICU恒大被罚41.75亿到底怎么缴湖南一县政协主席疑涉刑案被控制茶百道就改标签日期致歉王树国3次鞠躬告别西交大师生张立群任西安交通大学校长杨倩无缘巴黎奥运