V2EX = way to explore
V2EX 是一个关于分享和探索的地方
Sign Up Now
For Existing Member  Sign In
yangyaofei
V2EX  ›  Java

在 Javadoc 中如何应用 markdown 或者类似的文本标记语法

  •  
  •   yangyaofei ·
    yangyaofei · May 11, 2021 · 2078 views
    This topic created in 1822 days ago, the information mentioned may be changed or developed.

    以前一直在写 Python, 用 sphinx 写文档, 加个示例代码, 高亮标记, 加粗什么章节什么的都比较容易,也很简单

    最近有写东西要用 java 写, 发现 javadoc 只有部分 html 标签可以用,自带的 tag 也不是很好用.

    在 github 中找到了一个 https://github.com/Abnaxos/markdown-doclet ,可以用, 但是已经很久没 更新了,引入到 gradle 里面也各种错误(java 新手,gradle 玩不溜, 上次写 java 还是 SSH 时代).

    所以请问,有什么比较好的解决方案么,在代码里面手写 html 还有转义字符什么的实在是难以称之为好的 代码体验,java 都这么多年了,不应该都直接文档手敲纯文本文本,偶尔加点 html 标签吧

    No Comments Yet
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Solana   ·   5841 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 29ms · UTC 01:51 · PVG 09:51 · LAX 18:51 · JFK 21:51
    ♥ Do have faith in what you're doing.