Found warning comments in code JS-0099
Documentation
Minor
6 months ago
—
6 months old
Unexpected 'todo' comment: 'todo!'
193exports.getCategory = async (req, res) => {
194 const { id } = req.params
195 try {
196 //todo!197 //add functionality for the admin to show non activated (hidden) catgories.
198 const category = await Category.findById(id).where('isActive').equals(true)
199 if (!category) {
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
}