如果我用冒号（示例）关闭我的标签，它会对PHPdoc产生影响吗？

Question

我总是在我的phpdoc集团中使用冒号。例如，而不是：

/** Some comment
 *
 *@private
 * 
 *@param string $sTable The name of the table 
 *@return bool True otherwise void
 *@example className->tableExists($sTable);
 *@since date
 */

而不是上述内容，我使用以下样式：

/** Some comment
 *
 * @private
 * 
 * @param   : string $sTable The name of the table 
 * @return  : bool True otherwise void
 * @example : className->tableExists($sTable);
 * @since   : date
 */

你知道，我更喜欢用冒号来划分标签和描述。它更容易阅读，并有更多的风格。但是我想知道这对PHPdoc解析docbloc有什么不同吗？

Answer 1

对PHPDocumentor来说，它有很大的不同。测试显示以下

/**
 * Test constructor.
 * @param : string $var testvar
 *
 */

记录到：

哪里

/**
 * Test constructor.
 * @param  string $var testvar
 *
 */

输出

这是一种逻辑，因为它是一种语法错误。如果您想让docblock看起来不错，可以将值与空格对齐。

/** Some comment
 *
 *@private
 *
 *@param   string $sTable The name of the table
 *@return  bool|void      True otherwise void
 *@example className->tableExists($sTable);
 *@since   date
 */

Answer 2

我不确定PHPDoc本身，但它会对某些IDE产生影响。我在PHPStorm中尝试了此操作，虽然@param和@var未受影响，但@return失败了。

我会谨慎使用非标准格式。