评论评论块

Question

我有一个带有注释块的PHP代码：

function foo()
{
    $bar = true;
    /*
        Foo and bar do shopping
    */
    // and bars goes back alone
    return $bar;
}

现在，我想评论整个函数，所以我将它放在注释块中：

/*
function foo()
{
    $bar = true;
    /*
        Foo and bar do shopping
    */
    // and bars goes back alone
    return $bar;
}
*/

显然，评论会在第一个*/停止。 目前，我将/*和*/更改为/+和+/以便逃避它们。

/*
function foo()
{
    $bar = true;
    /+
        Foo and bar do shopping
    +/
    // and bars goes back alone
    return $bar;
}
*/

但是当我想取消对整个功能的评论时，我需要将其切换回/*和*/。

如果我使用//注释，使用Notepad ++中的Ctrl + q快捷键，代码行切换到注释，注释切换到代码，因此函数变为：

// function foo()
// {
    // $bar = true;
    // /*
        //Foo and bar do shopping
    //*/
    and bars goes back alone
    // return $bar;
// }

是否有更好的方法可以在评论栏中转义*/评论结束标记？

Answer 1

做： 您可以使用＃作为功能/行描述

/*

##############
# Description
##############
function sampleFunction(){

}


*/

Answer 2

即使您不认为commenting the code is a bad practise，嵌套评论可能是code smell：

1. 确保没有不必要的评论;
2. 使用 SCM （正如你可能已经在做的那样，比如Git或Subversion），经常提交并且不要害怕删除代码而不是评论它（你总能这样做） revert或reset，并恢复之前的提交。