-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathComments.js
More file actions
115 lines (87 loc) · 1.93 KB
/
Comments.js
File metadata and controls
115 lines (87 loc) · 1.93 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
//: 18.1 => Use /** ... */ for multiline comments
// bad
// make() returns a new element
// based on the passed in tag name
//
// @param {String} tag
// @return {Element} element
function make(tag) {
// ...
return element;
}
// good
/**
* make() returns a new element
* based on the passed-in tag name
*/
function make(tag) {
// ...
return element;
}
//: 18.2 => /** Use "//" for single line comments. Place single line comments on a newline above the subject of the comment. Put an empty line before the comment unless it's on the first line of a block */
// bad
const active = true; // is current tab
// good
// is current tab
const active = true;
// bad
function getType() {
console.log("fetching type...");
// set the default type to 'no type'
const type = this.type || "no type";
return type;
}
// good
function getType() {
console.log("fetching type...");
// set the default type to 'no type'
const type = this.type || "no type";
return type;
}
// also good
function getType() {
// set the default type to 'no type'
const type = this.type || "no type";
return type;
}
//: 18.3 => Start all comments with a space to make it easier to read. eslint: "spaced-comment"
// bad
//is current tab
const active = true;
// good
// is current tab
const active = true;
// bad
/**
*make() returns a new element
*based on the passed-in tag name
*/
function make(tag) {
// ...
return element;
}
// good
/**
* make() returns a new element
* based on the passed-in tag name
*/
function make(tag) {
// ...
return element;
}
//: 18.4 => Use // FIXME: to annotate problems.
class Calculator extends Abacus {
constructor() {
super();
// FIXME: shouldn’t use a global here
total = 0;
}
}
//: 18.5 => Use // TODO: to annotate solutions to problems.
class Calculator extends Abacus {
constructor() {
super();
// TODO: total should be configurable by an options param
this.total = 0;
}
}