- html - 出于某种原因,IE8 对我的 Sass 文件中继承的 html5 CSS 不友好?
- JMeter 在响应断言中使用 span 标签的问题
- html - 在 :hover and :active? 上具有不同效果的 CSS 动画
- html - 相对于居中的 html 内容固定的 CSS 重复背景?
我有一组类,每个类都在自己的文件中。我已经添加了适当的 DocBlock,这样我在构建文档时就不会收到任何错误或警告。这是一个非常简单的例子:
<?php
/**
* Page level description.
*/
/**
* Short class description.
*
* Longer description on what this class is all about.
*/
class Test {
// a bunch of code
}
?>
当我在此类上运行 phpdoc 时,页面级 DocBlock 不会出现在生成的 HTML 中的任何位置。
这可能是因为 2.0 版本仍处于 Alpha 阶段。如果我确实遗漏了什么,有人可以告诉我我遗漏了什么吗?
顺便说一句,我确实做了功课试图找到答案。我找到了 this post从 2 个月前开始,但它引用了 phpDocumentor 的早期版本,并且它看起来不像 OP 指定它是否满意地回答了问题。
最佳答案
[...] a Page-level DocBlock is the first DocBlock in a file if it contains a @package tag. [...]
<?php
/**
* Page-level DocBlock
* @package pagepackage
*/
/**
* Define DocBlock
*/
define("ahhhh","Now the Page-level DocBlock is for the page, and the Define DocBlock for the define");
?>
引用: http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_elements.pkg.html
关于phpDocumentor 2.0 页面级 DocBlock - 它在哪里?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/14552777/
我正在尝试正确注释我的代码,我通常不会从函数中回显任何内容,通常我只是返回数据,然后在需要时回显返回值。今天我编写了一个函数,该函数将仅在 View 文件中频繁使用,所以我想为什么不直接从函数内部回显
我有一段前段时间写的代码块,我正在寻找文档,但是其中一个函数有一个输出参数 - 应该如何编写一个 phpDoc block 来指定一个参数是一个输出参数? 注意 - 这不是“我喜欢输出参数”或“我想使
我正在使用来自 http://phpdoc.org 的 phpDocumentor . 尝试更改模板“responsive-twig”让我抓狂。我对 所做的任何更改 /usr/share/php/ph
响应式 phpdocumentor 模板中的链接似乎已损坏。例如,包的 url 包含 'db_Models' packages/db_Models/当从 URL 中删除 db_Models 时,它工作
我在让 phpdoc 正确运行时遇到了一些问题。大部分文档已成功生成,但我多次收到以下警告: Warning: date(): It is not safe to rely on the system
好吧,我受够了 phpDocumentator .它消耗的内存 (1.4 GB) 和时间(在 2.6GHz Core 2 Duo 上为 5 分钟)比我愿意提供的要多得多。是否存在一些真正兼容的程序来为
所以,基本上我有以下设置: class A { /** * This is some documentation */ public function foo()
我正在尝试为以下内容编写 phpdocumentor block : /** * daysBetween * * Returns the number of whole working days
我有一个类的公共(public)方法,我想记录该方法可以接受的可用字符串值。这是否可以接受: /** * Set size of photos * * @param string $size can
非常简单:可以在 phpDocumentor 标签内使用制表符吗?喜欢: /** * @param string @some_var Description */ @some_var
我需要为 PhpDocumentor 创建自定义模板。问题是 template.xml 中定义的路径,即使指定为绝对路径,也无法正确解析。 PhpDocumentor 在供应商目录中查找它们。
官网地址:http://www.phpdoc.org/ 项目地址:https://github.com/phpDocumentor/phpDocumentor2 phpDocumentor 2是一
我使用 Ubuntu 11.10,我想安装 phpdocumentor。我用教程How to install PhpDocumentor on Ubuntu .但: If you navigate t
如何逐步设置和使用 phpDocumentor? 我正在尝试使用 composer 有很多安装请求。谁能告诉我有关 phpDocumentor 设置和在 php 中使用的想法。 试过 $ compos
我的公司正在使用 mediawiki 处理最终用户/开发人员文档。我想获取 phpdoc 吐出的大量 API 文档(针对特定功能/方法)并将其放在 wiki 标记中以便于传输。 是否有任何解决方案可以
我已经通过 PEAR 安装了 PHP Documentor。但输出选项不起作用。当我使用像这样的简单命令时 phpdoc -d source/path -t target/path --templat
我似乎无法理解如何获取 PHPCocumentor2 @example标签才能正常工作。 我正在尝试解析单个文件。我的工作目录是 /home/developers/domains/example.co
或者它只是处于“完成”状态?我在我的所有 PHP 项目中使用 PHPDoc 多年,但我最近注意到 PHPDoc 网站上的最后一篇文章是 2008 年的。所以我想知道是否是时候研究其他替代方案,如 Do
/** * @property $Property */ class SomeClass { public function __get($name){ return $this
我想在 Unix 上手动安装 phpDocumentor 2 using the installer . 我对命令行的了解有限,但我确实有 root 访问权限。说明说将安装程序下载到预期位置。那么我应
我是一名优秀的程序员,十分优秀!