Part
V2EX  ›  PHP

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

  •  
  •   Part · Jan 30, 2013 · 4048 views
    This topic created in 4881 days ago, the information mentioned may be changed or developed.
    4 replies    1970-01-01 08:00:00 +08:00
    twm
        1
    twm  
       Jan 30, 2013
    不写
    sivacohan
        2
    sivacohan  
    PRO
       Jan 30, 2013   ❤️ 1
    PHPdoc

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

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

    每个方法写明接受的params

    写明return类型以及中间是否产生输出(一般没有必要的话,别产生输出)
    bj365fanyi
        3
    bj365fanyi  
       Feb 19, 2013   ❤️ 1
    文档你可以自己搭建一个Wiki或者考虑用Atlassian的一套软件管理项目和Bugs。

    注释就需要在每个PHP文件头部说清楚这个Class是干什么的,人性化一点描述。每个function和私有变量需要注释。Function需要包含每个param的解释和return的描述。Function里面的负责逻辑需要有相关的注释。
    anythink
        4
    anythink  
       Feb 20, 2013
    api doc wiki
    code doc phpdoc
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Solana   ·   894 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 60ms · UTC 20:24 · PVG 04:24 · LAX 13:24 · JFK 16:24
    ♥ Do have faith in what you're doing.