如何创建我的代码摘要答案

【问题标题】：How to create a summary of my code如何创建我的代码摘要
【发布时间】：2012-12-04 02:24:49
【问题描述】：

我想自动为我的代码（java）创建某种报告。例子：我有类似的东西：

public classe qwerty{
//CODE
/*
* Converts ...
* @param s
*        -string...
*/
public static int mult(string s)
   {
   //CODE
   } 
}

我想创建一个看起来像这样的东西：

...............................
public static int mult(string s)
Converts ...

Paramters:
   s (String): string...
Returns (int)
.................................
ETC

有什么工具吗？

【问题讨论】：

你看过javadoc吗？如果没有，它可能是您正在寻找的工具。
stackoverflow.com/questions/225447/doxygen-vs-javadoc
我相信 Eclipse IDE 可以帮助您创建 JavaDocs，这是一种用于 Java 代码的文档格式。您只需在编写方法后键入/** 即可启动文档注释块。

标签： java

【解决方案1】：

也许你正在搜索javadoc

Javadoc 将代码的 html 文件创建为文档。随便看看tutorial

【讨论】：

读完后，我想写什么，但它可以制作Word文档吗？
否；你为什么要那个？
曾经有用于 PDF 的 MIF Doclet
@LouisWasserman 因为我已经有了 Word 中的报告，我只需要添加函数和构造函数等。

【解决方案2】：

如果你看过 javadoc，但它不适合你，那么看看这个解决方案

How to read Javadoc comments by reflection?

查看答案“doclet”

【讨论】：

【解决方案3】：

如果您使用的是 IntelliJ，那么在您要评论的方法之前，您必须输入 /** 并按 Enter。它会根据您的功能自动创建带参数或不带参数的注释。

【讨论】：