Php 可以评论一下吗
我在评论时遇到了这种不便。但我想知道你们会怎么做。假设您有以下代码:Php 可以评论一下吗,php,comments,Php,Comments,我在评论时遇到了这种不便。但我想知道你们会怎么做。假设您有以下代码: /*Fancy function*/ function fancyFunction(){ echo "Oh yeah" //200 more lines go here } 现在我想对整个函数进行注释,您将执行以下操作: /* /*Fancy function*/ <--Comment breaks here function fancyFunction(){ echo "Oh yeah
/*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
}
*/
/*
/*奇特的功能*/我使用单行注释“//comment”
如果你有一个好的IDE,你可以通过按一个快捷键来注释一大堆行。您还可以评论:
// comment
function xyz();
评论:
// // comment
// function xyz();
您需要在每行上使用单行注释,例如
///*Fancy function*/
//function fancyFunction(){
// echo "Oh yeah"
// //200 more lines go here
//}
我使用的许多编辑器都具有以这种方式注释/取消注释所选文本的功能。例如,在记事本++中,在关联菜单上选择“切换块注释”。注释旨在为代码提供注释。一个通过阅读代码本身来告诉您和其他开发人员决策背后的推理或任何其他不明显的事情的系统
您最好的办法是删除有问题的代码。如果您正在使用版本控制(而且您应该这样做),您将永远不会丢失代码。我认为没有简单的方法可以解决这个问题,但这里有一个方便的快速评论提示:
// /*
function foo()
{
// do something
}
// */
现在,如果要注释掉函数,只需删除前两个斜杠:
/*
function foo()
{
// do something
}
// */
然而,我强烈反对这种风格。它看起来很难看,应该改用版本控制,正如前面几次提到的那样。正如前面提到的,长期策略是依赖版本控制系统,否则事情会变得非常混乱,特别是在尝试注释200行函数时(可能应该将其分解为更小、更易于阅读的函数)
尽管如此,我也发现自己需要暂时注释掉一个函数,同时测试其他函数,在VCS修订版之间来回跳转是额外的开销,等等
我通常只使用行注释(//…)进行注释,甚至对于多行注释也是如此,对于这些类型的临时函数替换,我只使用块注释(//*…*/)。一些IDE(或编辑器)支持这一点:它们允许您选择一个代码块,然后在该代码块的每一行的开头添加/
。我会使用源代码管理和删除我想要禁用的代码,而不是注释掉它…如果是临时的,并且没有很多*/只需在*和/之间添加空格。您需要一个颜色突出显示编辑器,以便可以轻松地ot他们。你可以添加注释,提醒你这个需要删除*///调试必须加入。我知道这不理想,但我还是很喜欢这个答案,因为它实际上说明了我的问题,因为你提醒了我注释的真正含义。