首页 > 编程语言 >JavaDoc

JavaDoc

时间:2022-09-29 22:55:18浏览次数:47  
标签:String Doc javadoc JavaDoc fch name

image-20220929182011408

生成 JavaDoc文档

package com.fch.operator;

/**       类注释(在类上面)
 * @author fch
 * @version 1.0
 * @since 1.8
 */
public class Doc {
    String name;

    /**    方法注释(方法上面)
     * @author fch
     * @param name
     * @return
     * @throws Exception    //下面的方法打出后,这里自动生成信息
     */
    public String test(String name) throws Exception{
        return name;

    //通过cmd命令行    格式:javadoc 参数  Java文件
    //练习:学会查找使用IDEA生产JavaDoc文档!     面向百度编程!
    }
}

打开文件 : Doc类(右键)>> Open in >>Explorer

image-20220929215945642

文件夹打开后cmd进入

javadoc -encoding UTF-8 -charset UTF-8 Doc.java

image-20220929215849233

生成html文件,进入index.html

image-20220929220259810

image-20220929220401037

标签:String,Doc,javadoc,JavaDoc,fch,name
From: https://www.cnblogs.com/fch999/p/16743405.html

相关文章

  • Javadoc转换chm帮助文档的四种方法总结
     1)将现有的html文件集(比如api)制作成chm文档​​​​​​http://www.blogjava.net/lishunli/archive/2010/01/07/308618.html​​ 我建议使用javadoc2chm,看上去最......
  • JavaDoc
    packagebase;publicclassDoc{Stringname;/****@paramname;*@return;*@throwsException;*///由/**回车打出......
  • JavaDoc
    JavaDocjavadoc命令是用来生成自己API文档的参数信息:@author作者名@version版本号@since指明需要最早使用的jdk版本@param参数名@return返回值情况......
  • JavaDoc注释
    生成API文档时的参数信息@author作者名@version版本号@since最早可使用的jdk版本@param参数名@return返回值@throws抛出异常生成自己的API说明文档使用CMD方......
  • 使用IDEA生成JavaDoc文档
    1.选中要生成的包:  2.点击标题栏上得Tools->GenerateJavaDoc...  3.:然后会弹出一个界面,然后在输出目录(Outputdirectory)输入框后面的按钮点击进去选择要保存的......
  • JavaDOC
    示例代码/***@authorMMF*@version1.0*@since1.8*/publicclassDoc{Stringname;/***@authorMMF*@paramname用户名*......
  • Java入门-基础语法(JavaDoc)
    JavaDoc用来生成自己的API文档,参数信息:@author@version@since@param@return@throws。使用命令行生成Doc.java编译成一份文档来帮助阅读(javadoc参数Doc.java),其中......
  • Java06-包机制&JavaDoc文档
    包机制为了更好的组织类,Java提供了包机制,用于区别类名的命名空间(等同于文件夹)一般利用公司域名倒置作为包名eg:com.baidu.www(会生成树状子目录)包语句的格式:packagepac......
  • 生成JavaDoc
    1.第一步:首先创建一个新的文件夹。2.第二步:选中所要生成的包。3.第三步:点击键盘shift两下,搜索tools,并选择生成javadoc(GenerateJavaDoc)这个选项。4.第四部:红色圈的都......
  • JavaDoc
    JavaDocJavaDoc是一种将注释生成HTML文档的技术,生成的HTML文档类似于Java的API,易读且清晰明了。只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就......