代码之家  ›  专栏  ›  技术社区  ›  Peter Becker

有没有使用类似wiki的语法的javadoc替代品?[关闭]

  •  11
  • Peter Becker  · 技术社区  · 16 年前

    有没有一个工具可以用wiki风格的语法代替普通javadoc的htmlish语法来代替javadoc?

    我的一个问题是,我主要以源代码形式阅读javadoc。即使对于外部库,我也会尝试附加源代码,这样我就可以从IDE导航到它,检查入口点上方的文档,如有必要,还可以检查下面的代码。

    另一个问题是,列表和代码示例这样的东西编写起来很混乱,特别是如果您的IDE坚持在每一行都加上星号。我想看到的是使用一种至少具有以下功能的wiki语法的内容:

    • 列表
    • 代码块
    • 与方法/类别交联

    还有很多东西是不错的,但我相信这些是最基本的。

    有人知道这种工具吗?

    2 回复  |  直到 14 年前
        1
  •  3
  •   Rich Seller    16 年前

    有一个项目叫 WikiDoclet 我从来没有用过,但我想看看你对它的看法。

    从网站:

    这是对JavaJDK提供的标准JavaDoc文档的扩展。它增加了对我所说的wiki格式的支持。这意味着您的javadoc现在可以使用比javadoc中嵌入的HTML更容易看到的文本规则进行格式化。例如,将重点放在围绕它的一段文本上 星星 . 斜体字 下划线 . 当运行doclet生成javadoc时,将评估这些规则并进行HTML替换。这种格式应该使读Java源代码变得容易得多,因为它不再被HTML标签所困扰。这对于项目符号列表和表格尤其适用。但是HTML仍然保留着,所以您可以根据自己的喜好进行混合和匹配。

    对于其他doclet格式,请签出 doclet.com .

        2
  •  3
  •   franz    16 年前