代码之家  ›  专栏  ›  技术社区  ›  Joonas Pulakka

不带HTML的Javadocs

  •  5
  • Joonas Pulakka  · 技术社区  · 14 年前

    罗伯特C。马丁的书 Clean Code 包含以下内容:

    源代码注释中的HTML是一个讨厌的东西[…]如果注释将被某个工具(如Javadoc)提取出来并出现在网页中,那么应该由该工具而不是程序员负责用适当的HTML来修饰注释。

    Javadoc manual 说得很清楚:

    文档注释是用HTML编写的。

    有一些预处理器工具可以在这里提供帮助吗? Markdown 语法可能是合适的。

    2 回复  |  直到 14 年前
        1
  •  3
  •   user166390 user166390    14 年前

    我同意(这也是我强烈反对C风格的“XML注释块”的原因;javadocdsl至少提供 顶级实体的转义!)。为此,我只是 不要

    ……不管怎样,你可能对强生感兴趣。这是一个很快的帖子 Doxygen versus Javadoc . 它还提出了您需要解决的问题:-)

        2
  •  0
  •   Axel    14 年前

    我不想在“普通”评论中看到HTML。但是对于像JavaDoc这样的工具,HTML增加了添加格式信息、要点等的可能性。。。

    我要区分这两件事:

    • javadoc注释用于生成文档。在有帮助的地方使用HTML。但是一个非常有限的HTML子集就足够了。