关于PHP注释
概述
关于评论的写作方式,我想稍微意识一下并为自己做了一些调查,将其记在备忘录中。
留言的方式
首先,如何写呢?
※ 参考PHPDoc
请写下最基本的评论。
在我进行调查的过程中,我发现了一篇有着相同思路的文章,我打算直接引用它。
※ 我想写上PHP Doc注释中最基本的部分。
如果了解每个输入/输出值的类型(并且它们是统一的),就可以使用它们。
由于经常看到不考虑类型的代码,我希望至少写下以下评论,并且请大家关注类型。
<对类型的注解>
@var [型] 説明
@param [型] 変数名 説明
@return [型] 説明
上述内容
请参考以下的网站
-
- PHPDoc reference
- 最低限書いておきたいPHPのDocコメント