推荐学习书目
› Learn Python the Hard Way
Python Sites
› PyPI - Python Package Index
› http://diveintopython.org/toc/index.html
› Pocoo
值得关注的项目
› PyPy
› Celery
› Jinja2
› Read the Docs
› gevent
› pyenv
› virtualenv
› Stackless Python
› Beautiful Soup
› 结巴中文分词
› Green Unicorn
› Sentry
› Shovel
› Pyflakes
› pytest
Python 编程
› pep8 Checker
Styles
› PEP 8
› Google Python Style Guide
› Code Style from The Hitchhiker's Guide
这是一个创建于 3686 天前的主题，其中的信息可能已经有所发展或是发生改变。
这里说的不是开源库,而是指一群人做的公司私有项目.
文档不仅是给python开发的同伴看,你还需要把文档维护起来给安卓,IOS,web以及其他人看,大家在这方面有什么心得?
一般我是我是一个窗口维护markdown,iterm2这边用vim写着代码.
也许平时这也没什么,不过现在我给团队重构代码,业务代码进行的很快(东西不多也不复杂),但是当我连写了5个接口,以及5个小文档结构的时候,已经感觉很机械了,特别是来回切换总是不大舒服...;
现在考虑是否将文档直接维护到代码doc里面然后通过pyment输出,但是怕把代码文件拉的太长(虽然很多开源项目都是这样子的),大家在这方面用过的有啥感受?
或者有没有更好的建议分享下..
文档不仅是给python开发的同伴看,你还需要把文档维护起来给安卓,IOS,web以及其他人看,大家在这方面有什么心得?
一般我是我是一个窗口维护markdown,iterm2这边用vim写着代码.
也许平时这也没什么,不过现在我给团队重构代码,业务代码进行的很快(东西不多也不复杂),但是当我连写了5个接口,以及5个小文档结构的时候,已经感觉很机械了,特别是来回切换总是不大舒服...;
现在考虑是否将文档直接维护到代码doc里面然后通过pyment输出,但是怕把代码文件拉的太长(虽然很多开源项目都是这样子的),大家在这方面用过的有啥感受?
或者有没有更好的建议分享下..
 |
1
piglei 2014-10-17 21:14:11 +08:00  1
我在前公司使用的方案是写在每一个View class的docstring里，使用markdown格式，另外有一个脚本扫描这些docstring生成文档，供参考。
|
 |
2
bcxx 2014-10-17 21:30:39 +08:00 1
sphinx 这样不行么？
|
 |
3
bigzhu 2014-10-17 21:48:48 +08:00 2
sphinx
顺便推销下我的 blog 用sphinx将python的注释生成文档: http://bigzhu.org/blog/%E7%94%A8sphinx%E5%B0%86python%E7%9A%84%E6%B3%A8%E9%87%8A%E7%94%9F%E6%88%90%E6%96%87%E6%A1%A3 |
 |
4
zeayes 2014-10-18 01:21:39 +08:00
trac wiki
|
 |
5
pythoner 2014-10-18 14:30:28 +08:00 1
同三楼
|
 |
6
GeekGao 2014-10-18 15:41:09 +08:00
wiki
|
 |
7
tolerious 2014-10-18 16:12:51 +08:00
Mark
|
 |
8
gkiwi OP |
Select Language