Java day03 三种注释的写法和javadoc.exe生成api

超、凢脫俗 2024-03-17 15:35 4阅读 0赞

单行注释

ctrl + /  添加取消行注释

按下 alt +  鼠标 左键可以列选择多行处理

![3bd87ea68cb443dcb9122aed8c5d01cd.png][]

可以在File>>Settings>>Editor>>Code Style>>Java>>Code Generotion

取消勾选Line comment at first column

![33d2bb5a27a84a8b97e3750f7aaca05b.png][]

这样注释就在语句前边了，当语句较多时，就会显得比较整洁（大家可以按照自己的喜好来）

![9cceb0d3e4694c44adc8c6e31ca19219.png][]

多行注释，块注释

ctrl + /

或者 /\*+enter（不推荐）

文档注释

ctrl+shift+/

/ \* \* + enter

可以表明作者、版本等信息

![56cc50fb1e1e47f28782db0762cefc65.png][]

可以在设置中设置类模板，这样以后写项目，文档注释就可以自动生成了

File>>Settings>>Editor>>File and Code Templatec>>lncludes

1 建立 File Top
 /*
 * Copyright (c) 2006, ${YEAR},联系方式 All rights reserved.
 *
 */
 
 
 2 添加File Header 
 /**
 *
 * Project: ${PROJECT_NAME} - ${NAME}
 * Powered by webrx On ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}:${SECOND}
 * 描述：
 * @author 自己id [邮箱等]
 * @version 1.0
 * @since 17
 */

![1eded0cc45534ce19cccf2f03a846276.png][]

![46e78237b221464fb09ded6f4e1c96f1.png][]

找到类模板
    #parse("File Top.java")
    #if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
    #parse("File Header.java")
    public class ${NAME} {
        public static void main(String[] args){
    		        
        }
    }

![07edb619d85d4468b30437f05748fe4d.png][]

这样新建java文件就会自动生成我们设置的注释了

![2240e7baa066498ca19debe5c9ec58ed.png][]

各种注释和类的结构属性和一个 javadoc.exe 命令相关，javadoc 命令可以根据文字的这些信息，快速生成类的 api 参考网页。

Tools>>Generate JavaDoc...

![148373ea426c4684a1fb32f69f9586d5.png][]

![0f9f00a660034b3ca0c80f17b81e8c1e.png][]

![00ea210198fc401190a89b6b3ac5346d.png][]

到这里就结束啦！

[3bd87ea68cb443dcb9122aed8c5d01cd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/bc0879b9163a4b4c8ed0567bd742f758.png
[33d2bb5a27a84a8b97e3750f7aaca05b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/8a9d8bb6c05b4c67b3dca6f9f40a1afd.png
[9cceb0d3e4694c44adc8c6e31ca19219.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/6da5b1c852774ea6a332f3f70bbda310.png
[56cc50fb1e1e47f28782db0762cefc65.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/1d14131f2504497aa2391465afd4561b.png
[1eded0cc45534ce19cccf2f03a846276.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/c6e2141209f543aea3f876f5f5cf6971.png
[46e78237b221464fb09ded6f4e1c96f1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/5d95e8b524fa4adc9184038285501073.png
[07edb619d85d4468b30437f05748fe4d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/7c5c0f221bfe4209972cbe24e989ecda.png
[2240e7baa066498ca19debe5c9ec58ed.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/dc63e3a0234f4a1fa7eb7fd16cf0b4b7.png
[148373ea426c4684a1fb32f69f9586d5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/bb73f6441cb74c6082bbed8a0c98f4f6.png
[0f9f00a660034b3ca0c80f17b81e8c1e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/722218af6f9240fc8b1e660cb7540afd.png
[00ea210198fc401190a89b6b3ac5346d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/f4663cb539db4c089647b6cdd8a4423c.png