• MyEclipse生成Javadoc帮助文档


    Javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形式程序的开发文档了。

    Javadoc输出的是一些静态网页文档,经过WEB浏览器来查看它。
    Javadoc的语言规则:
    所有Javadoc都只能源于结束。应用javadoc有二种方法:

    一种是嵌入静态网页;

    Javadoc将静态网页源代码嵌入到所生成的静态网页文档中。那样能充分利用静态网页的功能。比如:

    1.   

    另一种是应用文档标签

    Sample:

    1. import java.util.*;   
    2.    
    3. public class JavaDocTest {   
    4.    
    5. public static void main(String[] args){   
    6.      System.out.print("HelloWorld!");       
    7. }   
    8. }  


    Javadoc只能为public或者protected成员停止文档注释。private和包内访问的成员的注释会被忽略掉。那样做是有道理的,由于只有public和protected成员才能在文档之外被应用,这也体现了封装性的优点。

    一、利用Myeclipse都可轻松制作javadoc

    利用Myeclipse生产javadoc文档的步骤如下:

    1.选择File->Export->javadoc,下一步。

    2.Javadoc comand选择JDK的bin目录下的javadoc.exe。选择要生成的源代码和javadoc保存的目的路径,下一步。

    3.Document title输入标题,下一步。

    4.Extra Javadoc options输入

    -windowtitle 'Type B Monitor'[浏览器显示标题]

    -bottom <center>Travelsky</center>[底部显示文本],


    如果出现编码错误,则填写以下这句

    比如项目采用的是UTF-8的编码就填:

    -encoding UTF-8 -charset UTF-8

    二、利用3个插件都可轻松制作javadoc

    JDocEditor,JAutoDoc,Java2Html。三个小工具,轻松制作JavaDoc.一个是可见即所得的JavaDoc编辑工具,一个是自动建立代码注释的工具,一个是把代码转换成Html格式的工具。
    JDocEditor:
    http://www.certiv.NET/download/downloads.html#jdoceditor
    一个所见即所得的Java Doc 编辑器。不用再费神地在代码中调整注释的html标记了,可以自由地编出高质量的带丰富格式的Java Doc 。

    JAutoDoc
    http://jautodoc.sourceforge.Net/index.html#download
    自动建立Java Doc 文档。功能十分强大,三个命令实现在所有源代码中加入完整的Java Doc注释。一个命令是加入Package的说明文档,在Package中加入package.html,对package进行说明。
    第二个命令是代码文件的头部注释。一个命令就可以自动地在项目的所有代码文件中加入头部注释,或者替换原来的注释。
    第三个命令为类、方法、属性加入注释说明。可以根据模式匹配,自动地根据方法的名称,建立更为具有可读性的注释文本。

    Java2Html

    http://www.java2html.de/eclipse.html
    准确地说它不是用来直接建立JavaDoc 的,但是可以用来建立其他文档。它的功能是,把Eclipse中的语法色彩格式转换成为Html,让粘贴到网页上,或者其他文档中的代码带有清晰的语法格式。

  • 相关阅读:
    V4L2摄像头应用编程(转)
    ok6410 3.0.1内核调用V4L接口出错解决方法(转)
    Salesforce学习之路(十一)Aura组件属性<aura:attribute />
    Salesforce学习之路(九)Org的命名空间
    Salesforce学习之路(八)一次拉取多个文件或全部文件至本地
    Salesforce学习之路(十)Aura组件工作原理
    Salesforce学习之路(七)Visualforce结合Reports展示图表
    Salesforce学习之路(六)利用Visualforce Page实现页面的动态刷新功能
    Salesforce学习之路(五)role hierarchy & sharing
    Salesforce学习之路(四)利用Jenkins和Git实现Salesforce的CI/CD功能
  • 原文地址:https://www.cnblogs.com/anpajin/p/6376793.html
Copyright © 2020-2023  润新知