您好,欢迎来到三六零分类信息网!老站,搜索引擎当天收录,欢迎发信息

关于注释的写法与疑问

2024/5/11 15:16:34发布26次查看
最近在学习yii2,晃了几眼源代码,看到了类似怎样的注释:
@ - 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 */

不知道为什么要怎样写。求路过大神赐教。
回复内容: 最近在学习yii2,晃了几眼源代码,看到了类似怎样的注释:
@ - 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 */

不知道为什么要怎样写。求路过大神赐教。
这是符合phpdoc的注释格式,有很多工具可以解析这类注释并且直接生成文档,例如phpdocumentor, doxygen等等。ide例如eclipse的pdt,intelij的idea和phpstorm也能解析这种注释格式,并且根据注释来辅助生成代码提示
@vimac 是正解,这是phpdoc的注释规范,和yii2无关。
详情楼主可以谷歌一下phpdoc,这样有利于各种ide和编辑器对代码进行自动提示。yii apidoc功能也是需要这个的。
该用户其它信息

VIP推荐

免费发布信息,免费发布B2B信息网站平台 - 三六零分类信息网 沪ICP备09012988号-2
企业名录 Product