【问题标题】:Enums ordering in javadocjavadoc中的枚举排序
【发布时间】:2014-07-12 17:57:41
【问题描述】:

枚举的 Javadoc 始终使用字母顺序显示其常量。有可能改变吗?

例如,如果常量不显示为 FRIDAY、MONDAY、SATURDAY、SUNDAY、THURSDAY TUESDAY、WEDNESDAY...,javadoc for java.time.DayOfWeek 看起来会更好......

【问题讨论】:

  • 不知道有没有可能但是新的Java时间javadoc还没有做到这一点:docs.oracle.com/javase/8/docs/api/java/time/DayOfWeek.html
  • 我不是真的不明白这个问题。
  • 您的枚举示例似乎来自 Java8 中的 DayOfWeek。查看compareTo method in Enum 的Java8 javadoc 看起来顺序将是声明值的顺序,在您的示例中按字母顺序排列。
  • @AbimaranKugathasan OP 询问为什么 javadoc 工具按字母顺序而不是声明的顺序为声明的枚举值生成文档,以及是否可以更改此行为。
  • 不仅是枚举,所有的字段、方法都是按字母顺序排列的。

标签: java enums javadoc


【解决方案1】:

默认的 HTML doclet 对其成员的摘要进行排序。

Collections.sort(members);

来自/com/sun/tools/doclets/internal/toolkit/builders/MemberSummaryBuilder.java :312

最好不要这样做。

Javadoc 将摘要按字母顺序排列,以便您可以快速找到所需的摘要。打破该模型将使 Javadoc 更难快速扫描并找到您要查找的内容。

字母顺序仅适用于摘要,完整的 Javadoc 将按照源文件中的 decleration 顺序。


如果您真的需要这样做,那么您可以推出自己的 doclet 或者 taglet 或许能够做到。

【讨论】:

  • “你不能”的参考将把它变成一个有价值的答案。
  • @bruno 找不到 you can't 的参考资料,可能需要查看来源来证明这一点。但是,对于我们任何人都可以找到的摘要中的事物排序,不存在任何记录在案的机制。
  • “默认的HTML doclet不能这样做”的依据是什么?我们中的任何一个都可以找到一种方法来做到这一点?
  • @bruno 很难找到不存在的功能不存在的证据。在检查了 Javadoc 手册页、Oracle 文档、javadoc-dev 邮件列表和 SO 本身之后,发现我没有做任何威胁并抓住源来证明这一点。我希望这能让你满意。
  • 不错。我很不高兴它是按字母顺序排列的,直到你告诉我它只在摘要中。现在我认为默认行为非常有意义,按字母顺序显示以便于查找,如索引,并在详细信息中按声明顺序显示,用于上下文。
猜你喜欢
  • 2011-08-29
  • 2011-09-26
  • 1970-01-01
  • 2013-08-26
  • 1970-01-01
  • 1970-01-01
  • 2010-12-04
  • 1970-01-01
  • 2018-06-23
相关资源
最近更新 更多