java - 如何从源文件中提取 JavaDoc 注释

Question

如何从 Java 源文件中提取 JavaDoc 注释？以及我想要的格式？

Answer 1

有关标准方法，请参见Javadoc Tool Home Page的Doclets部分。

Doclets标准的 doclet 生成 HTML 并内置在 Javadoc 工具中。此处列出了 Java Software 开发的其他 doclet。..

特别参见Example - Subclassing the Standard Doclet & the Doclet API。

Answer 2

使用 javadoc *.java 生成它们，然后根据需要重写 stylesheet.css...

Answer 3

作为替代方案，您可以考虑我编写的一个名为 的类FilteredLineIterator，它可用于从源文件中抓取所有 JavaDoc 行。

（这个答案类似于我在这个问题中写的那个。）

AFilteredLineIterator是一个字符串迭代器，它根据每行存在的“实体”（单行、块和“隐形”块）过滤（保留或抑制）另一个迭代器中的元素。可以选择修改保留的行。

（FilteredLineIterator是XBN-Java的一部分。可以在这里下载 Jar 。）

示例顶部和设置：

   import  com.github.xbn.linefilter.FilteredLineIterator;
   import  com.github.xbn.linefilter.KeepUnmatched;
   import  com.github.xbn.linefilter.Returns;
   import  com.github.xbn.linefilter.entity.BlockEntity;
   import  com.github.xbn.linefilter.entity.EntityRequired;
   import  com.github.xbn.linefilter.entity.KeepMatched;
   import  com.github.xbn.linefilter.entity.NewBlockEntityFor;
   import  com.github.xbn.linefilter.entity.NewStealthBlockEntityFor;
   import  com.github.xbn.linefilter.entity.StealthBlockEntity;
   import  com.github.xbn.testdev.GetFromCommandLineAtIndex;
   import  com.github.xbn.util.IncludeJavaDoc;
   import  java.util.Iterator;
/**
  <P>{@code java ExtractAllJavaDocBlockTextRaw examples\com\github\xbn\examples\linefilter\JavaClassWithOneCommentAndTwoJavaDocBlocks_input.txt}</P>
 **/
public class ExtractAllJavaDocBlockTextRaw  {
  public static final void main(String[] cmd_lineParams)  {
     //Example setup:
        Iterator<String> rawInputLineItr = GetFromCommandLineAtIndex.fileLineIterator(
           cmd_lineParams, 0,
           null);   //debugPath

主要部分从下面开始。JavaDoc 块被定义为块实体，其中仅保留中间（不是开始或结束）行。为了防止不正确的“在块打开之前找到结束行”错误——因为 JavaDoc 和“正常”（非 JavaDoc）多行注释的结束行是——必须声明正常多行注释的*/隐蔽块。

输入的原始线迭代器和两个实体都被馈送到过滤的线迭代器。

     StealthBlockEntity javaMlcBlock = NewStealthBlockEntityFor.javaComment(
        "comment", IncludeJavaDoc.NO,
        null,       //dbgStart (on=System.out, off=null)
        null,       //dbgEnd
        KeepMatched.NO, EntityRequired.YES, null,
        null);      //dbgLineNums

     BlockEntity javaDocBlock = NewBlockEntityFor.javaDocComment_Cfg(
        "doccomment",
        null,       //dbgStart
        null,       //dbgEnd
        EntityRequired.YES, null,
        null).      //dbgLineNums
        keepMidsOnly().build();

     FilteredLineIterator filteredItr = new FilteredLineIterator(
        rawInputLineItr, Returns.KEPT, KeepUnmatched.NO,
        null, null,    //dbgEveryLine and its line-range
        javaMlcBlock, javaDocBlock);

     while(filteredItr.hasNext())  {
        System.out.println(filteredItr.next());
     }
  }
}

输出（输入文件在这个答案的底部）：

        <P>The main class JavaDoc block.</P>
      <P>Constructor JavaDoc block</P>
      * <P>Function JavaDoc block.</P>

      * <P>This function does some stuff.</P>

      * <P>Lots and lots of stuff.</P>

要从每一行中去除可选的星号，包括任何前面的空格，请在 JavaDoc 块实体中添加一个“中间行更改器”：

TextLineAlterer asteriskStripper = NewTextLineAltererFor.replacement(
   Pattern.compile("[ \t]*(?:\\*[ \t]*)?(.*)"), "$1",
   ReplacedInEachInput.FIRST,
   null,       //debug
   null);

keepMidsOnly().build();通过更改为将更改器添加到块实体

midAlter(asteriskStripper).keepMidsOnly().build();

输出：

<P>The main class JavaDoc block.</P>
<P>Constructor JavaDoc block</P>
<P>Function JavaDoc block.</P>

<P>This function does some stuff.</P>

<P>Lots and lots of stuff.</P>

输入文件：

/*
   A Java comment block.
 */
package  fully.qualified.package.name;
/**
   <P>The main class JavaDoc block.</P>
 */
public class StayClassy  {
   /**
      <P>Constructor JavaDoc block</P>
    */
   public StayClassy()  {
      //Do stuff
   }
   /**
      * <P>Function JavaDoc block.</P>

      * <P>This function does some stuff.</P>

      * <P>Lots and lots of stuff.</P>
    */
   public void doStuff()  {
   }
}