java - 如何创建我的代码摘要

Question

我想自动创建某种我的代码（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

有什么工具吗？？

Answer 1

也许您正在搜索javadoc

Javadoc 将代码的 html 文件创建为文档。看看一些教程

Answer 2

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

如何通过反射读取 Javadoc 注释？

看答案“doclet”

Answer 3

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