PHPDoc:如何记录不同的类属性选项

标签 php phpdoc

有没有办法使用 phpdoc 来记录类属性可以采用的不同值以及这将产生什么效果。例如:-

class SomeClass {

   /**
   * Cell text align
   * 
   * null - table default
   * l - left align
   * r - right align
   * c - centre align
   * j - justify
   */
   public $align;

   Some code
}

有没有办法让 phpdoc 解析值-描述对,以便将它们转换为定义列表或类似的内容?

最佳答案

这样的东西会变成 <ul>在文档输出中:

class SomeClass {

   /**
    * Cell text align
    * 
    * Possible values: 
    * - null - table default
    * - l - left align
    * - r - right align
    * - c - centre align
    * - j - justify
    */
   public $align;

   // Some code
}

来自the manual page on DocBlock description details .

关于PHPDoc:如何记录不同的类属性选项,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/9932113/

相关文章:

php - 为什么 array_walk() 没有按预期工作?

php - 使用 PHP 为 SQL 数据库准备 HTML 表单输入

php - 将 PHP 错误处理程序限制在特定的命名空间

php - 在表格行中找到一个值,如果存在,则更新它

php - 如何在 PHP (Java)Doc 中标记数组值类型?

yii - PHPDOC @property 关联到 getter

PHPDoc 和 PhpStorm : indicate the return type of a magic method

php 文件中的 phpdoc @var

当表数据有html代码时PHP MySQL通过电子邮件发送带有行的表

arrays - phpDoc 有没有办法将对象数组记录为参数?