高效地注释代码
由 Mux 主办的 DEV 全球展示挑战赛:展示你的项目!
你们大多数人可能会像这样注释掉代码:
...
main();
// alternateMain();
...
但这并不是一种高效的注释方式。如果你需要切换注释状态,至少需要删除/添加两个字符。而且,有时你可能在尝试两种不同的操作,需要注释掉其中一种,取消注释另一种。事情很快就会变得很复杂。
在这里,我将向您展示一些高效的注释方法。这些方法基于 JavaScript,但也应该适用于其他语言,例如 CSS、C 等。(您或许还可以将其改编为其他语言)。
可切换评论
要为一段代码添加注释并使其更容易取消注释,您可以这样做:
/*/
experimental();
/**/
如果要取消注释,只需*在第一行添加一个 a:
/**/
experimental();
/**/
这里不能“嵌套”评论,所以你可以使用的一个技巧是将评论内容放在最后一条评论中:
不:
/*/ never(); /* Some explanatory text here blabla */ experiment2(); /**/是的:
/*/ gonna(); experiment2(); /* Some explanatory text here blabla */
好的?
我们可以很容易地扩展这个功能。请看这里:
/*/
experimental();
/*/
stable();
/**/
现在,第一个代码块已被注释,但第二个代码块没有。只需添加一个冒号*(:)即可。
/**/
experimental();
/*/
stable();
/**/
啊,它被切换了,我们正在运行experimental()!
你甚至可以将它们内联放置:
use(/**/ stable /*/ experimental /**/);
如果要将两者都注释掉,只需删除*中间的逗号即可:
/*/
experimental1();
//
experimental2();
/**/
如果你想取消两者的注释,请*在中间添加一个 a:
/**/
experimental1();
/**/
experimental2();
/**/
很棒吧?
现在看来事情似乎已经结束了,但还有更多!
看看这个:
/**/
experimental1();
/**/
experimental2();
/**/
give();
/**/
如果要注释掉一行,只需删除/该行顶部的一个结尾字符即可:
/**/
experimental1();
/**
experimental2();
/**/
you();
/**/
也适用于多行!
/**/
experimental1();
/**
experimental2();
/**
up();
/**/
你可以几乎无限地扩展这个范围。当然,别让这些评论超出“只是测试一下”的阶段……
文章来源:https://dev.to/siddharthshyniben/efficiently-commenting-code-5148