是否可以评论评论

时间:2011-09-04 11:14:14

标签: php commenting

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

/*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

5 个答案:

答案 0 :(得分:7)

评论旨在为您提供代码评论。一个系统,通过阅读代码本身,告诉您和其他开发人员决策背后的原因或其他任何不明显的原因。

您最好的选择是删除相关代码。如果你正在使用版本控制(你应该),你永远不会丢失代码。

答案 1 :(得分:3)

我认为没有简单的方法,但这里有一个方便快速评论的提示:

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

现在,当你想要注释掉这个函数时,只需删除前两个斜杠:

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

但是,我强烈反对这种风格。它看起来很丑陋,应该使用版本控制,如前几次提到的那样。

答案 2 :(得分:1)

我使用单行注释“// comment”。

如果你获得了很好的IDE,你可以通过按一个快捷键来评论一堆行。您还可以评论评论:

// comment
function xyz();

表示:

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

答案 3 :(得分:1)

您需要在每一行上使用单行评论,例如

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

我使用的许多编辑器都具有以这种方式评论/取消对所选文本进行注释的功能。例如。在上下文菜单中的notepad ++中选择“切换块注释”。

答案 4 :(得分:1)

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

然而,尽管如此,我还发现自己处于需要暂时注释掉某个功能的位置,同时测试其他内容,并且在VCS修订版等之间反向和反向反弹是额外的开销。

我通常只使用行注释(// ...)进行注释,即使是多行注释,我也只使用块注释(/ * ... * /)进行这些临时函数替换。< / p>