寫程式碼到底需不需要寫註釋？

我們常常看到一些老外寫的原始碼，往往包含大段大段的註釋，註釋常常比實際程式碼還多。有的註釋不光只在描述程式碼本身，還有好多是在描述作者當時寫程式碼的心情的，感覺跟寫散文一樣，還夾雜著一些個人情感。高人就是高人，行事異於常人。

還有些底層配置資訊，也是很有必要的，什麼數值對應什麼配置，免得還要去翻資料手冊。

必要的註釋

但是我發現有些職場新人，也很喜歡寫註釋。一段簡單函式，寫一堆有的沒的，很是影響程式碼的閱讀。因此，寫註釋有時候並不是一件好事。

舉個例子，判斷一個數是否為素數

不好的寫法，

// 判斷m是否為素數

//返回值：1:是素數，0:不是素數

int p(int m)

{

int k = sqrt(m);

for(inti=2;i<=k;i++)

if(m%i== 0)

break;// 發現整除，表示m不為素數，結束遍歷

//遍歷中沒有發現整除的情況，返回

if(i>k)

return1;

//遍歷中沒有發現整除的情況，返回

else

return0;

}

重構程式碼後，不需要註釋：

int IsPrimeNumber(intnum)

{

int sqrt_of_num = sqrt(num);

for(int i=2;i<=sqrt_of_num;i++)

{

if(num% i== 0)

{

return FALSE;

}

}

return TRUE;

}

從上面這個例子就可以看出，好的命名方式和結構化的寫法，完全可以取代那些沒有必要的註釋。