javadoc 命令生成类的解释文档

首先介绍 Java 的 3 种注释:

1. // 单行注释

2. /*
    多行注释
   */ 

3. /**
    文档注释 可以借助 javadoc 的命令将文档注释(markdown)生成为html
   */

建个 CommentTest 类,路径 csu\src\CommentTest.java

package com.shuai.test;

/**
 * Created by shuai
 * on 2017/8/15.
 * @author shuai 作者
 * @since 1.0 JDK 版本
 */

public class CommentTest {

    /**
     * @param s String
     * @return String
     */
    public String test(String s) {
        return "hello";
    }

    public static void main(String[] args) {
        
    }
}

命令行执行命令

ShuaideMacBook-Pro:src shuai$ javadoc -d ../doc CommentTest.java 
正在加载源文件CommentTest.java...
正在构造 Javadoc 信息...
正在创建目标目录: "../doc/"
标准 Doclet 版本 1.8.0_131
正在构建所有程序包和类的树...
正在生成../doc/com/shuai/test/CommentTest.html...
正在生成../doc/com/shuai/test/package-frame.html...
正在生成../doc/com/shuai/test/package-summary.html...
正在生成../doc/com/shuai/test/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...

之后就生成了完整的注释,路径 csu\doc

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 135,067评论 19 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 173,822评论 25 709
  • 儿子算是随心所欲地耍完了整个暑假。整整两个月的假期,对于知识性的东西他了解得少之又少。钢琴也孤伶伶地在那儿站了两个...
    筱猪儿的妈妈阅读 180评论 0 0
  • 多希望我是你肚子里的蛔虫,可以随时随地知道你在想些什么; 多希望你有什么心事,都可以和我诉说,这样我就多少可以帮你...
    兔先森9225阅读 642评论 0 1
  • 第一:ArcGIS入门教程系列 我们根据ArcGIS最新版本整理了详细的入门教程,有了她,你可以最快的速度上手Ar...
    gischen阅读 4,137评论 0 41