# doc-demo

**Repository Path**: steven-wu/doc-demo

## Basic Information

- **Project Name**: doc-demo
- **Description**: Doc Demo, Show you how to write a qualified note.Now Include PHP/Javascript(注释标签范例，助你能更好理解每个注释标签的作用，目前包含了PHP/Javascript
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-03-17
- **Last Updated**: 2021-03-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# DocDemo

<!-- 
* [English version](./README_EN.md)
-->

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

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

[![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/yinggaozhen/doc-demo/blob/master/LICENSE)

:heart::heart::heart:标签会不定期持续更新，欢迎各位**fork & star**:heart::heart::heart:

## [PHP相关注释标签](https://github.com/yinggaozhen/doc-demo/tree/master/php)

||||||
|---|---|---|---|---|
|[@author](./php/author)|[@deprecated](./php/deprecated)|@example|[@inheritdoc](./php/inheritdoc)|[@link](./php/link)|
|[@method](./php/method)|@mixin|[@param](./php/param)|[@property](./php/property)|[@return](./php/return)|
|[@see](./php/see)|[@throws](./php/throws)|[@var](./php/var)|[@internal](./php/internal)|@version|
| @copyright | @license| @since |@package |@todo |

## [Javascript相关注释标签](https://github.com/yinggaozhen/doc-demo/tree/master/javascript)

||||||
|---|---|---|---|---|
|[@abstract](./javascript/abstract)|@access|[@constructor](./javascript/constructor)|[@default](./javascript/default)|[@deprecated](./javascript/deprecated)|
|@example|[@inheritdoc](./javascript/inheritdoc)|@link|[@member](./javascript/member)|[@param](./javascript/param)|
|[@returns](./javascript/returns)|[@see](./javascript/see)|@this|[@throws](./javascript/throws)|[@type](./javascript/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](https://chrome.google.com/webstore/detail/octotree/bkhaagjahfmjljalopjnoealnfndnagc)
- firefox : [https://addons.mozilla.org/en-US/firefox/addon/octotree/](https://addons.mozilla.org/en-US/firefox/addon/octotree/)

### 2. Jetbrains全家桶

所谓[Jetbrains](https://www.jetbrains.com/)全家桶，即`PHP -> PhpStorm`， `Javascript -> (PhpStorm/WebStorm)`.

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

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

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

## 相关参考资料

- PHPDoc : [https://docs.phpdoc.org/](https://docs.phpdoc.org/)
- JsDoc : [http://www.dba.cn/book/jsdoc/](http://www.dba.cn/book/jsdoc/)
 
## 特别感谢

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

- @popo1h
- @czewail