精华内容
下载资源
问答
  • Eclipse文档注释

    2019-03-02 16:48:54
    文档注释这么写    /**  * @author apple  * 类GetSum实现整数求和  * @version 1.0  */   public class GetSum{ /**  * 方法getSum计算两个...

                                                                                                                                                  点击此处返回总目录

     

    我们自己写了一个类,想让别人使用。就需要告诉他怎么使用。

     

    文档注释这么写 

     

    /**

     *   @author apple

     *   类GetSum实现整数求和

     *   @version  1.0

     */

     

    public class GetSum{

    /**

     *  方法getSum计算两个整数的求和

     *  调用此方法传递两个整数,返回求和

     *  @prarm a

     *  @prarm b

     *  @return 

     */

             public static void  int getSum(int a, int b){

                     return a+b;

             }

     

    }

     

     

    把写的文档注释导出帮助文档:

    在要导出的包上,右键->Export->java -> javadoc,然后选择路径,导出即可。注意生成的是一个网页,打开index.html即可。

     

     

     

     

    展开全文
  • 文档注释快捷键 shift+alt+j 自定义文档注释 打开Eclipse--Window--Perference--Java--Code Style--Code Templates--Comments--Type--Edit 比如: /**  * @author: ${user}  * @Description:  * @Time:${...

    文档注释快捷键

    shift+alt+j

    自定义文档注释

    打开Eclipse--Window--Perference--Java--Code Style--Code Templates--Comments--Type--Edit

    比如:

    /**
     * @author: ${user}
     * @Description:
     * @Time:${date} ${time}  
     * ${tags}
     */

     

    展开全文
  • Eclipse文档注释生成doc方法

    千次阅读 2015-11-30 21:29:01
    Eclipse文档注释生成doc方法 1.项目-->右键菜单Export-->Java下Javadoc-->next: javadoc command:就是要调用的javadoc.exe,在java安装位置中; use standarddoclet:就是要生成到的目录,自定义一个...

    Eclipse文档注释生成doc方法

    1.项目-->右键菜单Export-->Java下Javadoc-->next:


    <1>javadoc command:就是要调用的javadoc.exe,在java安装位置中;


    <2>use standarddoclet:就是要生成到的目录,自定义一个文件夹作为存放目录[不然一大堆];

    <3>默认即可next-->再next-->

    <4>【注意注意】此时如果项目采用的是UTF-8编码,ExtraJavadoc options下需要输入设定参数:-encoding utf-8 -charset utf-8否则生成的网页中文注释都是乱码。


    <5>最后Finish完成。

    在工程的doc 目录中,就有Javadoc文档了

     

     

     

    -------------------------------------------

    如何规范生成JAVADOC帮助文档

    1.文本注释(/** */)也叫归档注释。

           归档注释是一种专用注释;当它放在类或类成员声明之前时,javadoc工具可以提取出这些注释并用它们来生成程序的HTML文档。归档注释通常入在类、接口、方法及字段定义之前。

     

    2.文本注释中的“文档标记”(Doctags)是一些以“@”开头的命令;

     

    3.javadoc只能为public(公共)和protected(受保护)成员处理注释文档。“private”(私有)和“友好”成员(即没有访问控制符)的注释会被忽略,我们看不到任何输出(也可以用-private标记包括private成员)。

     

    4.类文档标记

    类文档可以包括用于版本信息以及作者姓名的标记。

    (1)@version

    格式如下:

    @version 版本信息

    其中,“版本信息”代表任何适合作为版本说明的资料。若在javadoc命令行使用了“-version”标记,就会从生成的HTML文档里提取出版本信息。

    (2) @author

    格式如下:

    @author 作者信息

    其中,“作者信息”包括您的姓名、电子函件地址或者其他任何适宜的资料。若在javadoc命令行使用了“-author”标记,就会专门从生成的HTML文档里提取出作者信息。

    可为一系列作者使用多个这样的标记,但它们必须连续放置。全部作者信息会一起存入最终HTML代码的单独一个段落里。

     

    5.方法文档标记

    方法允许使用针对参数、返回值以及异常的文档标记。

    (1)@param

    格式如下:

    @param 参数名 说明

    其中,“参数名”是指参数列表内的标识符,而“说明”代表一些可延续到后续行内的说明文字。一旦遇到一个新文档标记,就认为前一个说明结束。可使用任意数量的说明,每个参数一个。

    (2)@return

    格式如下:

    @return 说明

    其中,“说明”是指返回值的含义。它可延续到后面的行内。

    (3)@exception

    有关“异常”(Exception)的详细情况,

            @exception 完整类名 说明

            “完整类名”明确指定了一个违例类的名字,它是在其他某个地方定义好的。

           而“说明”(同样可以延续到下面的行)告诉我们为什么这种特殊类型的违例会在方法调用中出现。

    (4)@deprecated该标记的作用是建议用户不必再使用一种特定的功能,因为未来改版时可能摒弃。

            若将一个方法标记为@deprecated,则使用该方法时会收到编译器的警告。

     

    顺便提一下在eclipse下,当鼠标处于类,方法定义行时,按Alt+Shift+J,就可以快速添加文档注释。至于如何导出javadoc文档,eclipse环境下,file> export > javadoc >这里只要选中你要导出的*.java文件即可,要十分注意的是,通常很多人的classpath环境下,带有 %classpath%这使javadoc命令无法正确地执行。而提示的出错信息通常是IlleagalArgumentException。

    展开全文
  • 首先使用文档注释的快捷键是alt +shift +j 想要更改为你想要的格式操作如下: 打开eclipse Window–>Preferences–>Java–>Code Style --> Code Templates --> Comments --> types --> Edit ...

    首先使用文档注释的快捷键是alt +shift +j
    想要更改为你想要的格式操作如下:

    打开eclipse

    Window–>Preferences–>Java–>Code Style --> Code Templates --> Comments --> types --> Edit
    在这里插入图片描述
    默认格式如图所示
    安装自己喜欢的格式修改即可,下图是笔者的格式,可以参考:
    在这里插入图片描述
    快捷键alt+shift+j看到效果图如下
    在这里插入图片描述

    展开全文
  • 在方法/属性上输入/**后敲回车,Eclipse会自动安装模版里面的补充注释。 会生成类似: /** * @param xx * @param xx * @return xx   */
  • 上培训班时所用,希望对你有帮助!可以看VXGZH【子从】,有详细的内容助你一笔之力。
  • eclipse文档注释配置

    千次阅读 2018-03-03 00:06:14
    1.首先复制下面的文件,新建文本文件,并且命名为codetemplates.xml <?xml version="1.0" encoding="UTF-8"?> <templates>     autoinsert="false"  context="filecomment_...4.完成,回到eclipse测试注释模板
  • 例如: /** * @param * @return */ 快捷键为:ALT + SHIFT +J 想更换为其他的快捷键: Window--&... 另外如果觉得注释也不爽时也可以改改,修改的方法有两种: 1.直接在eclipse给的模板下...
  • eclipse设置文档注释的格式

    千次阅读 2018-01-28 16:40:24
    eclipse设置文档注释的格式
  • eclipse自定义文档注释

    2020-07-13 16:38:11
    文档注释编写codeTeamplate.xml导入测试 编写codeTeamplate.xml <?xml version="1.0" encoding="UTF-8" standalone="no"?><templates><template autoinsert="false" context="methodcomment_context...
  • 文档注释: 位置: Window-->preferences-->java-->Code Style-->Code Templates-->Comments-->Types-->Edit 具体位置如上图所示: 内容参考: /** * @description * @author ZYL ...
  • 1、Window---Preference---Java---Code Style---Code Templates 2、选择Comments---Import
  • 效果:
  • 这份文档详细说明了myEclipse/Eclipse中是如何配置java文档注释的,每次在myEclipse/Eclipse中写java代码时就可以用同一的文档注释了,减少了手工注释的麻烦。
  • 1、点击Window,选择Preferences 2、在Java–>Code Style–>Code Templates中,分别选择Types、Methods,点击Edit... Types模板 /** * @description: * @author: Jeff * @date: ${date} ... * @descriptio...
  • 简要介绍文档注释的写法及如何用eclipse生成文档注释
  • 目录 一、导出jar包... 2 1、项目-->右键菜单Export-->...二、导出文档注释... 6 1、java代码中基本使用注释标签... 6 2、操作eclipse导出文档... 8 (1)项目-->右键菜单Export-->Java下J...
  • 使用Eclipse生成注释文档 使用eclipse生成文档(javadoc)主要有三种方法:  1,在项目列表中按右键,选择Export(导出),然后在Export(导出)对话框中选择java下的javadoc,提交到下一步。  在Javadoc ...
  • 例如: /** @param @return */ 快捷键为:ALT + SHIFT +J 想更换为其他的快捷键: ...另外如果觉得注释也不爽时也可以改改,修改的方法有两种: 1.直接在eclipse给的模板下进行修改 2.自己编写一个xml...
  • Eclipse编写注释文档

    2018-11-27 14:55:19
    1. 点击Comments下的Files可对整个Java文件进行注释:包括公司名称,版权所属,作者信息,日期等。 /** * &lt;p&gt;Title: ${file_name}&lt;/p&gt; * &lt;p&gt;Description: &lt;/p&...
  • 首先创建一个java类用于生成Javadoc文档,类的上面添加类注释,有作者和日期等信息,然后为类添加一个... 使用Eclipse生成文档注释:点击Project--&gt;Generate Javadoc,如下图所示。 点击Generate...
  • 自定义文档注释模板,比较全面,基本内容都有涉及到,可以参考。
  • Eclipse Java 注释模板

    2013-04-12 22:36:21
    Eclipse Java 注释模板,设置后可以使用快捷键快速生成文档注释,版本信息等。
  • 每次用eclipse自动生成get、set方法后,收到加注释比较麻烦,幸运的是eclipse可以在生成方法时自动加上文档注释,不过默认情况下是不自动加注释的。 开启方法如下: 设置文档注释内容,Windows–>Preferences–>java...
  • /** *这种格式的注释就是文档注释 */ 快捷键是alt+shift+j,将光标放在类名,变量名,方法名上,按快捷键。 转载于:https://www.cnblogs.com/andong2015/p/4308341.html...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 35,339
精华内容 14,135
关键字:

eclipse文档注释