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

V2EX = way to explore

V2EX 是一个关于分享和探索的地方

现在注册

已注册用户请登录

这是一个创建于 4302 天前的主题，其中的信息可能已经有所发展或是发生改变。

PHPer

文档

各位

4 条回复 • 1970-01-01 08:00:00 +08:00

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