2011-09-04 192 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修訂版本之間反彈和反轉等額外的開銷等。

我通常只使用行註釋(// ...)進行註釋,即使對於多行註釋,我也只對這些臨時函數替換樣式使用塊註釋(/ * ... * /)。