Add typedef shorthand in jsdoc
This commit is contained in:
parent
1e927dccfc
commit
a001fdcc00
21
jsdoc.md
21
jsdoc.md
|
@ -80,6 +80,27 @@ function play (song) {
|
||||||
|
|
||||||
See: <http://usejsdoc.org/tags-typedef.html>
|
See: <http://usejsdoc.org/tags-typedef.html>
|
||||||
|
|
||||||
|
### Typedef Shorthand
|
||||||
|
|
||||||
|
```js
|
||||||
|
/**
|
||||||
|
* A song
|
||||||
|
* @typedef {{title: string, artist: string, year: number}} Song
|
||||||
|
*/
|
||||||
|
```
|
||||||
|
|
||||||
|
```js
|
||||||
|
/**
|
||||||
|
* Plays a song
|
||||||
|
* @param {Song} song - The {@link Song} to be played
|
||||||
|
*/
|
||||||
|
|
||||||
|
function play (song) {
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
See: <http://usejsdoc.org/tags-typedef.html>
|
||||||
|
|
||||||
### Importing types
|
### Importing types
|
||||||
|
|
||||||
```js
|
```js
|
||||||
|
|
Loading…
Reference in New Issue