PHP注释的艺术——phpDoc规范

最近学习写框架的时候 想把Yii2框架 中的

Yii::$app->request->get();

这样的方法应用到自己的框架中，在实现的过程中发现拼写request的时候没有代码提示，

对于一名搬砖程序员来说没有代码提示是多么痛苦的事情，通过查阅资料发现，代码提示是通过注释引导的，所以想把这个知识点分享一下。

PHPDOC

PHPDoc 是一个 PHP 版的 Javadoc。它是一种注释 PHP 代码的正式标准。它支持通过类似 phpDocumentor 这样的外部文档生成器生成 API 文档，也可以帮助一些例如 Zend Studio, NetBeans, ActiveState Komodo Edit and IDE 和 Aptana Studio 之类的 集成开发环境 理解变量类型和弱类型语言中的其他歧义并提供改进的代码完成，类型提示和除错功能。

PHPDoc 可同时支持 面向对象 的和 面向过程的 代码。

以上摘自维基百科

简单来说PHPDOC可以用来自动生成API文档。主流的IDE都会识别它，并在你coding中给予你相应的智能提示。使用PHPDOC有以下好处

• 让你的代码更加规zhuang范bi，更易于理解

• 让你的IDE更懂你的代码，更加智能的提示和自动完成

• 如需API手册，可使用phpDocumentor来自动生成

还等什么？快跟我一起来学习又好用又有逼格的phpDoc吧！

有关phpDoc的完整文档位于phpDocumentor官网。

文章转载：https://www.mokeyjay.com/archives/1211