這是親眼所見的一小段代碼，讀后感只有四個字：廢話少說！

// 在一個數(shù)組中，找到最大值并返回
int maxStudent(int student[], size_t arraySize) {
// 將最大值初始化為 -1
int maxValue = -1;

// 遍歷整個數(shù)組，查找最大值
for (size_t i=0; i<arraySize; ++i) {
// 如果數(shù)組中的當(dāng)前項大于最大值
if (student[i] > maxValue) {
// 則記錄新的最大值
maxValue = student[i];
}
}

//返回數(shù)組中的最大值
return maxValue;
}

完全無法忍受這樣的注釋，它除了啰嗦地將代碼又重復(fù)了一遍、增加了閱讀者的的閱讀量，并沒有起到任何有益的作用。這段代碼平身是無懈可擊的，但冗長而無用的注釋完全破壞了這一切，如果把所用的注釋都去掉（除了表達函數(shù)功能的那一句），可讀性反而大大提高：

//返回student數(shù)組中最大的值
int maxStudent(int student[], size_t arraySize) {
int maxValue = -1;
for (size_t i=0; i<arraySize; ++i) {
if (student[i] > maxValue) {
maxValue = student[i];
}
}
return maxValue;
}

現(xiàn)在剩下的惟一遺憾是，maxStudent這個函數(shù)名不夠清楚，我們無從知道“值”是指學(xué)生成績，還是指學(xué)生學(xué)號，或者學(xué)生的身高體重，如果這個函數(shù)名取得更好，能夠直接說明問題，那么連函數(shù)功能那句注釋都可以去掉。

---

原則：

• 好的代碼是自注釋的。
• 注釋應(yīng)該說明要解決的問題，而不是說明解決問題的方法。

總結(jié)

以上是生活随笔為你收集整理的废话少说的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。