ICode9

精准搜索请尝试: 精确搜索
首页 > 编程语言> 文章详细

如何创建phpdoc教程/扩展页面以补充注释的代码

2019-11-07 04:30:16  阅读:285  来源: 互联网

标签:phpdoc php documentation


我正在尽一切努力获取phpdocumentor,以允许我使用DocBook教程格式来补充它创建的文档:

>我正在使用Eclipse
>我已经在OSX机器上通过PEAR安装了phpDocumentor
>我可以从我的php类运行并自动生成代码
>它不会格式化教程-我找不到解决方案

我尝试将.pkg示例文件移动到整个文件结构中,并在子文件夹中使用与代码中引用的包相似的名称..我真的很茫然-如果有人可以解释在哪里放置它们, .pkg和其他DocBook文件,它们与它们正在记录的代码有关,以及它们如何触发phpdoc对其进行格式设置,对此我将不胜感激,此刻我正在使用它:

phpdoc -o HTML:Smarty:HandS
-d "/path/to/code/classes/", "/path/to/code/docs/tutorials/"
-t /path/to/output

解决方法:

我没想到会回答我自己的问题,但是经过两天的痛苦折腾和一个周末的实验后,看来这是问题所在:

本教程和我的示例都可以使用,但是phpdoc解释开关值的方式似乎有一个小缺陷.这是我一直在使用的:

phpdoc -o HTML:Smarty:HandS
-d "/path/to/code/classes/", "/path/to/code/docs/tutorials/"
-t /path/to/output

但是,如果使用以下命令:

    phpdoc -o HTML:Smarty:HandS 
-d /path/to/code/classes/, /path/to/code/docs/tutorials/
-t /path/to/output

它将正确格式化您的教程和扩展文档,我所做的就是删除目录路径周围的双引号.单引号根本不起作用-因为phpdoc本身在没有空格的情况下用双引号将目录包装起来……这似乎是phpdoc的错误,并且基于Web的界面也发生了相同的行为,因此它是内部的问题.我最初的尝试应该可以奏效,但我不会与开发人员联系并引起他们的注意.

问题解决了.

标签:phpdoc,php,documentation
来源: https://codeday.me/bug/20191107/2003220.html

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有