Skip to content

Commit 94d629e

Browse files
committed
add: js comments snippets
1 parent 14db570 commit 94d629e

File tree

3 files changed

+43
-0
lines changed

3 files changed

+43
-0
lines changed

comment/js/README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# JavaScript Comments Snippets
2+
3+
### [jc-method] method comment
4+
5+
```javascript
6+
/**
7+
* @method ${1:Method name}
8+
* ${2:Documentation for the method}
9+
* @param {${3:String}} ${4:Description of the param}
10+
* @return {${5:String}} ${6:Description of the return}
11+
*/
12+
```
13+
14+
### [jc-property] property comment
15+
16+
```javascript
17+
/**
18+
* @property {${1:Boolean}} ${2:[property=false]}
19+
* ${3:Description}
20+
*/
21+
```
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<snippet>
2+
<content><![CDATA[
3+
/**
4+
* @method ${1:Method name}
5+
* ${2:Documentation for the method}
6+
* @param {${3:String}} ${4:Description of the param}
7+
* @return {${5:String}} ${6:Description of the return}
8+
*/
9+
]]></content>
10+
<tabTrigger>jc-method</tabTrigger>
11+
<description>Method Comment</description>
12+
</snippet>
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<snippet>
2+
<content><![CDATA[
3+
/**
4+
* @property {${1:Boolean}} ${2:[property=false]}
5+
* ${3:Description}
6+
*/
7+
]]></content>
8+
<tabTrigger>jc-property</tabTrigger>
9+
<description>Property Comment</description>
10+
</snippet>

0 commit comments

Comments
 (0)