java maven项目文档生成

[TOC]

说明:良好的编程规范能给自己和别人带来方便,自己阅读别人的代码时,由于注释不完善,没少浪费自己的时间。所以以后的代码尽量要有规范的注释。

java规范的blog

  1. javadoc注释规范
  2. Bluestorm's Space
  3. java代码注释规范

新建maven项目

pom.xml添加插件

<build>
    <plugins>
        <plugin>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>2.9.1</version>
            <configuration>
                <docfilessubdirs>true</docfilessubdirs>
            </configuration>
        </plugin>
    </plugins>
</build>
idea MavenPlugins

为项目生成doc文档

生成后的文档

生成后的文档
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 136,264评论 19 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 177,073评论 25 709
  • 生活中,很多人一遇不平,或者为了所谓的“尊严”,一时意气用事,带着情绪与对方较劲,结果弄得鸡飞蛋打,即便是获得了暂...
    好习惯2011阅读 1,256评论 0 0
  • 我是从关注孙宇晨的财富自由革命之路,才接触的区块链。当时觉得都是90后,人家是如何实现财富自由的呢?听了那个节目才...
    Andrew1992阅读 3,089评论 3 5
  • 总会遇到一些人,有些人注定是你生命里的癌症,而有些人只是一个喷嚏而已。这一切,据说都是‌‌“因了冥冥中的缘分‌‌”...
    别山举水阅读 4,957评论 55 78

友情链接更多精彩内容