为 phpdoc 声明大量变量,而不以 /** 开头

Declaring lots of variables for phpdoc without starting each with /**

提问人:Pekka 提问时间:11/4/2009 更新时间:11/4/2009 访问量:821

问:

我有包含许多变量的对象,我在注释中声明和解释这些变量。我正在非常彻底地评论以后使用 phpDoc 进行处理,但是我还没有实际编译文档的经验。

我发现非常烦人的是,使用 phpDoc 表示法,即使我唯一想设置的属性是描述,每个变量也会占用四到六行代码:

/**
 * @desc this is the description
 */

 var $variable = null;

我想使用以下符号:

# @desc this is the description
var $variable = null;

有没有一种简单的方法可以调整 phpDoc 以接受这一点,或者当我实际尝试从中编译文档时会给我带来麻烦吗?我现在不需要调整(尽管当然很感激),只是一个了解 phpDoc 的人的声明,这是否可行,而无需重新设计其大部分代码。

php 文档 phpdoc

评论


答:

12赞 Frank Farmer 11/4/2009 #1

只需编写一行文档块

/** @desc this is the description */
var $variable = null;

问题解决了。

2赞 mauris 11/4/2009 #2

除了弗兰克·法默(Frank Farmer)提到的(+1他的解决方案),

/**自 PHP 5 以来,在 PHP 分词器中声明为。这意味着文档符号都是从 到 解析的。T_DOC_COMMENT/***/

你不能只使用或编写你的PHP文档。#/*

看:

http://www.php.net/manual/en/tokens.php

评论

0赞 Pekka 11/4/2009
好吧,显然你可以,但我认为你必须改变 PHPDoc(这不是我想要做的)。
0赞 Pekka 11/4/2009
我仍然不明白,如果您相应地更改 phpDoc 的解析,为什么不能使用 # 或 /* 作为文档?你愿意详细说明吗?
0赞 mauris 11/4/2009
为什么要更改phpDoc的解析?
1赞 Pekka 11/5/2009
为什么不呢?我不认为人们改变phpDoc以满足他们的需求有什么问题。正如我所说,鉴于我所提出的解决方案,我不打算这样做。然而,为了后代可能会偶然发现这一点,我想说的是,如果你真的需要,你可以使用 # 或 /* 来编写你的 PHP 文档;它可能只是与一些工作有关。