可以评论评论吗?


Is it possible to comment comments

我在评论时遇到了这种不便。但我想知道你们会怎么做。假设您有以下代码:

/*Fancy function*/
function fancyFunction(){
 echo "Oh yeah"
 //200 more lines go here
}

现在我想注释整个函数,你会这样做:

/*
/*Fancy function*/             <--Comment breaks here
function fancyFunction(){
 echo "Oh yeah"
 //200 more lines go here
}
*/

怎么做呢? xD

注释意味着为您的代码提供注释。一个通过阅读代码本身来告诉你和其他开发人员决策背后的原因或其他不明显的东西的系统。

最好的办法是删除有问题的代码。如果你正在使用版本控制(你应该),你将永远不会丢失代码。

我认为没有简单的方法可以绕过它,但是这里有一个方便的快速注释技巧:

// /*
function foo()
{
    // do something
}
// */

现在,当您想注释掉该函数时,只需去掉前两个斜杠:

/*
function foo()
{
    // do something
}
// */

然而,我强烈反对这种风格。它看起来很丑,应该使用版本控制,就像之前提到的那样。

我用了一行注释"//comment"

如果你有一个好的IDE,你可以按一个快捷键注释一堆行。

// comment
function xyz();

评论道:

// // comment
// function xyz();

您需要在每行上使用单行注释,例如

///*Fancy function*/
//function fancyFunction(){
// echo "Oh yeah"
// //200 more lines go here
//}

我用过的很多编辑器都有这种方式注释/取消注释选定文本的功能。例如,在notepad++的上下文菜单上选择"toggle block comment"

正如前面提到的,长期策略是依赖于版本控制系统,否则事情会变得非常混乱,特别是当试图注释掉200行函数时(可能应该将其分解成更小的更容易阅读的函数)。

然而,话虽如此,我也发现自己处于需要临时注释掉一个函数的位置,同时测试其他东西,这是一个额外的开销,在VCS版本之间来回弹跳,等等。

我通常只使用行注释(//…)进行注释,即使是多行注释,我也只使用块注释(/*…)