Found warning comments in code JS-0099
Documentation
Minor
a month ago
—
10 months old
Unexpected 'todo' comment: 'TODO: check for edits'
49 selector += `div#reply${post.no}`;
50 const elementExists = $(selector).length > 0;
51 if(elementExists)
52 continue; // TODO: check for edits 53
54 const $post = createPostElement(post, thread.board, "reply");
55 const $replyContainer = $("<div/>").prop({
Description
Developers often add comments to code that is not complete or needs review. You probably want to fix or review the code and then remove the comments before considering the code to be production-ready. Issues are raised whenever our analyzer finds these keywords in the comments i.e., TODO, FIXME, XXX.
// TODO: do something
// FIXME: this is not a good idea
Bad Practice
// default - { "terms": ["todo", "fixme", "xxx"], "location": "start" }
function callback(err, results) {
if (err) {
console.error(err);
return;
}
// TODO
}
Recommended
// default - { "terms": ["todo", "fixme", "xxx"], "location": "start" }
function callback(err, results) {
if (err) {
console.error(err);
return;
}
// NOT READY FOR PRIME TIME
// but too bad, it is not a predefined warning term
}