【发布时间】:2016-05-05 04:15:44
【问题描述】:
对于编程课程,我需要将 cmets 放在每个类和方法中,描述以下五件事:方法、字段、字段上的方法、参数和参数方法。前三个直接放在类标题下,后两个特定于每个方法。
下面是这些 cmets 应该是什么样子的示例。
class ConsLoString implements ILoString {
/*
* Methods:
* - String convertToString();
* - String formatString();
* Fields:
* - String first;
* - ILoString rest
* Methods on fields:
* - All String methods
* - All ILoString methods
*/
String first;
ILoString rest;
...
当然,为一个大文件中的每个类和方法都输入所有这些是乏味和多余的。有没有办法在 Eclipse 或其他方式中自动生成这些?
我查看了 Eclipse 的 Java Editor Template Variables,但似乎没有办法在 Eclipse 的模板编辑器中遍历类中的每个方法/字段。
非常感谢任何帮助!
【问题讨论】:
-
赞成你的问题,反对你课程中的这个要求。回击他们,向他们展示 javadoc 应该如何工作。如果您正确使用 javadoc,您将获得正确的摘要,而无需维护您的编程课程对您的要求。在“真实”世界中,我会非常警惕任何需要这种 Java 文档样式的公司。