各位PHPer都是怎么写项目文档的？

2013-01-30 09:10:29 +08:00
 Part
3453 次点击
所在节点    PHP
4 条回复
twm
2013-01-30 09:18:34 +08:00
不写
sivacohan
2013-01-30 09:30:02 +08:00
PHPdoc

文件开头简单说明文件位置，作者，开始时间

每个类前面做一个简单描述，如果有依赖关系也写在这

每个方法写明接受的params

写明return类型以及中间是否产生输出（一般没有必要的话，别产生输出）
bj365fanyi
2013-02-19 14:08:51 +08:00
文档你可以自己搭建一个Wiki或者考虑用Atlassian的一套软件管理项目和Bugs。

注释就需要在每个PHP文件头部说清楚这个Class是干什么的，人性化一点描述。每个function和私有变量需要注释。Function需要包含每个param的解释和return的描述。Function里面的负责逻辑需要有相关的注释。
anythink
2013-02-20 14:45:41 +08:00
api doc wiki
code doc phpdoc

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

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

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

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

© 2021 V2EX