关于注释的写法与疑问

php中文网
发布: 2016-06-06 20:23:24
原创
1285人浏览过

最近在学习yii2,晃了几眼源代码,看到了类似怎样的注释:

<code>@ - 1

/**
 * User model
 *
 * @property integer $id
 * @property string $username
 * @property string $password_hash
 * @property string $password_reset_token
 * @property string $email
 * @property string $auth_key
 * @property integer $status
 * @property integer $created_at
 * @property integer $updated_at
 * @property string $password write-only password
 */

@ - 2

/**
 * @inheritdoc
 */
public static function tableName()
{
    return '{{%user}}';
}

@ - 3

/**
 * @var \common\models\User
 */</code>
登录后复制

不知道为什么要怎样写。求路过大神赐教。

回复内容:

最近在学习yii2,晃了几眼源代码,看到了类似怎样的注释:

<code>@ - 1

/**
 * User model
 *
 * @property integer $id
 * @property string $username
 * @property string $password_hash
 * @property string $password_reset_token
 * @property string $email
 * @property string $auth_key
 * @property integer $status
 * @property integer $created_at
 * @property integer $updated_at
 * @property string $password write-only password
 */

@ - 2

/**
 * @inheritdoc
 */
public static function tableName()
{
    return '{{%user}}';
}

@ - 3

/**
 * @var \common\models\User
 */</code>
登录后复制

不知道为什么要怎样写。求路过大神赐教。

这是符合phpdoc的注释格式,有很多工具可以解析这类注释并且直接生成文档,例如phpDocumentor, doxygen等等。IDE例如eclipse的PDT,InteliJ的IDEA和PHPStorm也能解析这种注释格式,并且根据注释来辅助生成代码提示

法语写作助手
法语写作助手

法语助手旗下的AI智能写作平台,支持语法、拼写自动纠错,一键改写、润色你的法语作文。

法语写作助手 31
查看详情 法语写作助手

@vimac 是正解,这是phpDoc的注释规范,和YII2无关。

详情楼主可以谷歌一下phpdoc,这样有利于各种IDE和编辑器对代码进行自动提示。YII APIDOC功能也是需要这个的。

相关标签:
php
最佳 Windows 性能的顶级免费优化软件
最佳 Windows 性能的顶级免费优化软件

每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
热门推荐
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号