用什么工具编写文档?

2011-05-29 12:33:00 +08:00
 sqbing
你平时用什么工具维护代码的文档?
6212 次点击
所在节点    Python
7 条回复
chone
2011-05-29 12:42:11 +08:00
python文档通常是自述的,不需要javadoc什么那样的,直接从代码就能查看相关文档。
http://diveintopython.org/power_of_introspection/index.html
fly2never
2011-05-29 13:20:39 +08:00
@chone javadoc也可以写在代码里面,然后通过工具生成出来
icyflash
2011-05-29 13:36:24 +08:00
加注释,自动生成
chone
2011-05-29 14:21:03 +08:00
@fly2never 我的意思就是不用像那样,单独生成一个文档,python的源代码就是文档,python自身提供了相关的查看方法,在代码里做好注释就行了,这个被称为Introspection。
jjgod
2011-05-30 01:27:46 +08:00
在这里问,当然是 Sphinx 了。
sqbing
2011-05-30 08:02:24 +08:00
@icyflash 是的,我就是想自动生成的PDF或者html格式的文档
balabalaguguji
2019-10-30 18:53:25 +08:00
你可以试下易文档,这个很好用 https://easydoc.top

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

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

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

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

© 2021 V2EX