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

2021-05-11 14:33:55 +08:00
 yangyaofei

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

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

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

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

1322 次点击
所在节点    Java
0 条回复

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/776230

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX