評論註釋塊

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

但我需要切換回/*和*/當我要取消註釋的整體功能。

如果我使用//註釋，使用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中或顛覆），頻繁地進行提交，不要害怕刪除代碼，而不是評論它的（你總是可以做一個revert或reset，和恢復以前的提交）。