wojiukankan/doc-demo

Doc Demo, Show you how to write a qualified note.Now Include PHP/Javascript(注释标签范例，助你能更好理解每个注释标签的作用，目前包含了PHP/Javascript

DocDemo

注释标签范例，每个标签我都制作了相关图文信息，意在能帮你能更好理解每个注释标签的作用.目前包含了PHP/Javascript(ES5 & ES6).

或许你离漂亮的代码，就差一个标签^_^

❤️❤️❤️标签会不定期持续更新，欢迎各位fork & star❤️❤️❤️

PHP相关注释标签

@author	@deprecated	@example	@inheritdoc	@link
@method	@mixin	@param	@property	@return
@see	@throws	@var	@internal	@version
@copyright	@license	@since	@package	@todo

Javascript相关注释标签

@abstract	@access	@constructor	@default	@deprecated
@example	@inheritdoc	@link	@member	@param
@returns	@see	@this	@throws	@type
@copyright	@license	@since	@author	@todo
@global	@ignore	@file	@implements	@memberOf
@exports	@mixes	@mixin	@module	@namespace
@override	@static	@typedef	@version	@requires

阅读姿势

你可以采用以下两种方法查阅

1. 安装浏览器扩展octotree

需要在浏览器上安装对应的github阅读插件octotree，安装成功之后重新刷新github工程即可.

插件下载地址

• chrome : https://chrome.google.com/webstore/detail/octotree
• firefox : https://addons.mozilla.org/en-US/firefox/addon/octotree/

2. Jetbrains全家桶

所谓Jetbrains全家桶，即PHP -> PhpStorm， Javascript -> (PhpStorm/WebStorm).

理由是强大的Jetbrains已经很贴心为我们集成各个语言的标签识别，可以更快速的帮助我们理解每个标签的含义.

当然如果你觉得Jetbrains全家桶过于臃肿，也没关系，我们为每个标签都制作了详细的图文信息，放置于每个标签下的README.

毕竟注释标签只是各个语言各自约定一套通用规则，无关乎于IDE

相关参考资料

• PHPDoc : https://docs.phpdoc.org/
• JsDoc : http://www.dba.cn/book/jsdoc/

特别感谢

感谢以下同学给出的宝贵意见与指导

• @popo1h
• @czewail