PHPDocumentor的注释标签全解析

发布时间:2024-07-19 15:06:05 作者:小樊
来源:亿速云 阅读:81
  1. @deprecated: 标记一个项目、类、方法或属性已经被废弃,不再建议使用。

  2. @inheritdoc: 标记一个方法来自于父类或接口,用于继承文档化。

  3. @param: 用于描述一个方法的参数,包括参数名称、类型和描述。

  4. @return: 用于描述一个方法的返回值,包括返回值类型和描述。

  5. @throws: 描述一个方法可能抛出的异常,包括异常类型和描述。

  6. @var: 用于描述一个属性的类型和描述。

  7. @link: 创建一个超链接到指定的URL。

  8. @see: 创建一个交叉引用到其他文档元素。

  9. @example: 提供一个示例代码片段,用于演示如何使用一个方法或类。

  10. @since: 标记一个项目、类、方法或属性添加的版本号。

  11. @version: 标记一个项目、类、方法或属性的版本号。

  12. @author: 标记一个项目、类、方法或属性的作者。

  13. @license: 标记一个项目、类、方法或属性的许可证信息。

  14. @package: 标记一个项目、类、方法或属性所属的包名。

  15. @subpackage: 标记一个项目、类、方法或属性所属的子包名。

  16. @category: 标记一个项目、类、方法或属性的分类。

  17. @global: 标记一个全局变量。

  18. @var-read: 标记一个只读属性。

  19. @var-write: 标记一个可写属性。

  20. @param-read: 标记一个只读参数。

  21. @param-write: 标记一个可写参数。

  22. @property: 描述一个属性的类型和描述。

  23. @property-read: 标记一个只读属性。

  24. @property-write: 标记一个可写属性。

推荐阅读:
  1. PHP中有哪些常见的运行模式
  2. PHP作为服务器端语言有哪些优点

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

php

上一篇:如何利用Documentor管理大型PHP项目文档

下一篇:自定义Documentor输出样式的方法

相关阅读

您好,登录后才能下订单哦!

密码登录
登录注册
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》