Joo*_*kka 5 html comments javadoc
Robert C. Martin的书清洁代码包含以下内容:
源代码注释中的HTML是令人厌恶的[...]如果某些工具(如Javadoc)将提取注释以显示在网页中,那么它应该是该工具的责任,而不是程序员的装饰适当的HTML评论.
我有点同意 - 如果没有HTML标签,源代码肯定看起来更干净 - 但是你如何制作看起来不错的Javadoc页面呢？如果不使用HTML标记,就无法分隔段落.Javadoc手册清楚地说:
doc评论是用HTML编写的.
是否有一些预处理工具可以帮助到这里？Markdown语法可能是合适的.
小智 3
我同意。（这也是我强烈反对 C# 风格的“XML 注释块”的原因；Javadoc DSL 至少为顶级实体提供了一些转义！）。为此，我只是不想让 javadoc 看起来漂亮......
...无论如何，您可能对 Doxygen 感兴趣。这是一篇非常简短的文章Doxygen 与 Javadoc 对比。它还会提出您所做的问题:-)
| 归档时间： |
|
| 查看次数： |
823 次 |
| 最近记录： |