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 -> PhpStormJavascript -> (PhpStorm/WebStorm).

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

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

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

相关参考资料

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

特别感谢

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

@popo1h @czewail

版权声明:

1、该文章(资料)来源于互联网公开信息,我方只是对该内容做点评,所分享的下载地址为原作者公开地址。
2、网站不提供资料下载,如需下载请到原作者页面进行下载。
3、本站所有内容均由合作方或网友上传,本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺!文档内容仅供研究参考学习用!
4、如文档内容存在违规,或者侵犯商业秘密、侵犯著作权等,请点击“违规举报”。