All Projects → yinggaozhen → Doc Demo

yinggaozhen / Doc Demo

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

Programming Languages

javascript
184084 projects - #8 most used programming language

Labels

Projects that are alternatives of or similar to Doc Demo

Z Player
a flutter demo app with fish-redux
Stars: ✭ 53 (-15.87%)
Mutual labels:  demo
Multi Tenant App Demo
Demonstrates the discriminator field (shared schema) based multi-tenant application using Spring Boot & Hibernate 5.
Stars: ✭ 57 (-9.52%)
Mutual labels:  demo
Test demo
Testing Using Python Demo. 使用Python测试脚本demo。
Stars: ✭ 60 (-4.76%)
Mutual labels:  demo
K8sdemo
Kubernetes demo
Stars: ✭ 53 (-15.87%)
Mutual labels:  demo
Vww
[LPIRC 2019] First place in the Visual Wake Words challenge (TF-lite track)
Stars: ✭ 56 (-11.11%)
Mutual labels:  demo
Lypaymentfield
多种风格的支付框控件,可定制加密图片,也可使用带动画的弹窗。A variety of styles of payment box controls can be customized to encrypt pictures, can also be used with animated alert.
Stars: ✭ 58 (-7.94%)
Mutual labels:  demo
Ts2jsdoc
Generate JSDoc from Typescript
Stars: ✭ 52 (-17.46%)
Mutual labels:  jsdoc
Yii2 Swagger Demo
The showcase for yii2-swagger
Stars: ✭ 60 (-4.76%)
Mutual labels:  demo
Short Words
visualise lengthy words
Stars: ✭ 56 (-11.11%)
Mutual labels:  demo
Simple Vpn Demo
A Simple Point-to-Point tunnelling implementation in C
Stars: ✭ 59 (-6.35%)
Mutual labels:  demo
Parse Comments
Parse JavaScript code comments. Works with block and line comments, and should work with CSS, LESS, SASS, or any language with the same comment formats.
Stars: ✭ 53 (-15.87%)
Mutual labels:  jsdoc
Svelte Simple Datatables
A Datatable component for Svelte
Stars: ✭ 56 (-11.11%)
Mutual labels:  demo
Leealert
优雅的可自定义 Alert ActionSheet
Stars: ✭ 1,097 (+1641.27%)
Mutual labels:  demo
Flutter douban
豆瓣Flutter版
Stars: ✭ 53 (-15.87%)
Mutual labels:  demo
Vue Transition Demo
Demo for "Creating Vue.js Transitions & Animation"
Stars: ✭ 60 (-4.76%)
Mutual labels:  demo
Godot Multiplayer Demo
A multiplayer demo using Godot Engine's (2.2) high level networking
Stars: ✭ 52 (-17.46%)
Mutual labels:  demo
Node Ocr Demo
实现验证码识别,基于 node.js 配合 tesseract 和 graphicsmagick
Stars: ✭ 57 (-9.52%)
Mutual labels:  demo
Spring Boot Webflux Swagger Starter
An example project to illustrate how to document Spring Boot Webflux with Swagger2
Stars: ✭ 62 (-1.59%)
Mutual labels:  demo
Redemo
react demo component
Stars: ✭ 60 (-4.76%)
Mutual labels:  demo
Moviesinsetsdemo
Movies demo app to show WindowInsets handling
Stars: ✭ 59 (-6.35%)
Mutual labels:  demo

DocDemo

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

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

LICENSE

❤️❤️❤️标签会不定期持续更新,欢迎各位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工程即可.

插件下载地址

2. Jetbrains全家桶

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

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

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

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

相关参考资料

特别感谢

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

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].