ThirdMirrors
/
cheatsheets
mirror of https://gitee.com/Hawkin99/cheatsheets.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

jsdoc: update

This commit is contained in:
Rico Sta. Cruz 2017-10-29 20:04:52 +08:00
parent 3ee6f48ed2
commit 78701ecb78
No known key found for this signature in database
GPG Key ID: CAAD38AE2962619A
1 changed files with 15 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
jsdoc.md
View File

@ -1,9 +1,12 @@
--- ---
title: Jsdoc title: Jsdoc
category: JavaScript category: JavaScript
layout: 2017/sheet
updated: 2017-10-29
weight: -1
--- ---
## Functions ### Functions
```js ```js
/* /*
@ -22,9 +25,9 @@ category: JavaScript
function foo(n) { return n } function foo(n) { return n }
``` ```
See: http://usejsdoc.org/index.html See: <http://usejsdoc.org/index.html>
## Types ### Types
``` ```
/** /**
@ -38,16 +41,18 @@ See: http://usejsdoc.org/index.html
*/ */
``` ```
See: http://usejsdoc.org/tags-type.html See: <http://usejsdoc.org/tags-type.html>
## Variables ### Variables
```js ```js
/** /**
* @type {number} * @type {number}
*/ */
var FOO = 1 var FOO = 1
```
```js
/** /**
* @const {number} * @const {number}
*/ */
@ -64,7 +69,9 @@ const FOO = 1
* @property {string} artist - The artist * @property {string} artist - The artist
* @property {number} year - The year * @property {number} year - The year
*/ */
```
```js
/** /**
* Plays a song * Plays a song
* @param {Song} song - The {@link Song} to be played * @param {Song} song - The {@link Song} to be played
@ -74,9 +81,9 @@ function play (song) {
} }
``` ```
See: http://usejsdoc.org/tags-typedef.html See: <http://usejsdoc.org/tags-typedef.html>
## Renaming ### Renaming
```js ```js
/* /*
@ -85,4 +92,4 @@ See: http://usejsdoc.org/tags-typedef.html
*/ */
``` ```
Prefer `alias` over `name`. See: http://usejsdoc.org/tags-alias.html Prefer `alias` over `name`. See: <http://usejsdoc.org/tags-alias.html>