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 安卓adb backup备份应用数据失败
  • ¥15 eclipse运行项目时遇到的问题
  • ¥15 关于#c##的问题:最近需要用CAT工具Trados进行一些开发
  • ¥15 南大pa1 小游戏没有界面,并且报了如下错误,尝试过换显卡驱动,但是好像不行
  • ¥15 没有证书,nginx怎么反向代理到只能接受https的公网网站
  • ¥50 成都蓉城足球俱乐部小程序抢票
  • ¥15 yolov7训练自己的数据集
  • ¥15 esp8266与51单片机连接问题(标签-单片机|关键词-串口)(相关搜索:51单片机|单片机|测试代码)
  • ¥15 电力市场出清matlab yalmip kkt 双层优化问题
  • ¥30 ros小车路径规划实现不了,如何解决?(操作系统-ubuntu)