2011-09-04 160 views
2

我在评论时有这个不便之处。但我想知道你们如何做到这一点。比方说,你有下面的代码:是否可以评论评论

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

+0

某些IDE(或编辑器)支持:它们让您选择一段代码,然后在该块的每一行的开始处添加“//”。 –

+3

我会使用源代码管理和删除代码我想禁用而不是评论它... – delnan

+0

如果暂时且没有多少* /只是在*和/之间添加空格。你需要一个颜色突出的编辑器,这样你可以很容易地发现它们。你可以添加评论,提醒你这是需要删除*//调试必须加入。我知道不理想,但仍然 –

回答

7

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

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

+3

我真的很喜欢这个答案,因为它实际上说明了我的问题,因为你提醒我什么意见是真的。 –

1

我用单行评论“//评论”。

如果您获得了良好的IDE,您可以通过按一个快捷键评论一堆线。您也可以发表评论意见:

// comment 
function xyz(); 

评论:

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

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

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

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

3

我觉得有它周围没有简单的方法,但这里有一个方便的技巧快速评论:

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

现在,当你想注释掉的功能,只是删除了前两个斜线:

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

但是,我强烈反对这种风格。它看起来很丑陋,应该使用版本控制来代替,如前几次所述。

1

如前所述,长期战略是依靠版本控制系统,否则事情会变得非常混乱,特别是当试图注释200行功能时(这可能应该分成更小更容易阅读功能)。然而,尽管如此,我还发现自己需要暂时注释掉一个函数,同时测试其他的东西,并且在VCS修订版本之间反弹和反转等额外的开销等。

我通常只使用行注释(// ...)进行注释,即使对于多行注释,我也只对这些临时函数替换样式使用块注释(/ * ... * /)。