dongzhi1904 2014-02-21 08:45
浏览 24

如何为PHP项目创建自动代码文档?

I have a big project, that uses CakePHP. Now I would like to create a documentation for other new co-workers.

An idea was to use the existing PHPdoc comments and other comments inside the code to create an automatic documentation for a start.

  1. How can I manage such a big project and How would I create a browsable HTML-Documentation?

  2. How can I automatically add missing comments?
    (I use Eclipse for coding, but if it is easier in another editor I wouldn't mind.)
    There are many functions declared like this:

    # some explanation not in phpDoc
    function whatever() {
    ....
    }

It would be optimal if I could use an external Editor to edit only the phpdoc comments and they were automatically inserted in the sourcecode at the right positions.

  • 写回答

2条回答 默认 最新

  • dqayok7935 2014-02-21 11:18
    关注

    I am not sure how much this will fulfill your requirement.

    But the NetBeans IDE will help you on documentation.

    For documentation guide, you can refer the below site:

    Here is a guide for documentation

    Please suggest if you can find better.

    评论

报告相同问题?

悬赏问题

  • ¥15 matlab 用yalmip搭建模型,cplex求解,线性化处理的方法
  • ¥15 qt6.6.3 基于百度云的语音识别 不会改
  • ¥15 关于#目标检测#的问题:大概就是类似后台自动检测某下架商品的库存,在他监测到该商品上架并且可以购买的瞬间点击立即购买下单
  • ¥15 神经网络怎么把隐含层变量融合到损失函数中?
  • ¥15 lingo18勾选global solver求解使用的算法
  • ¥15 全部备份安卓app数据包括密码,可以复制到另一手机上运行
  • ¥20 测距传感器数据手册i2c
  • ¥15 RPA正常跑,cmd输入cookies跑不出来
  • ¥15 求帮我调试一下freefem代码
  • ¥15 matlab代码解决,怎么运行