|
一直以來都存在代碼注釋的作用的討論。很多人認為注釋是不必要的,寫注釋那是因為代碼可讀性太差了。我也同意這個原則。如果必須添加注釋,我覺得可以添加一些解釋代碼為什么,而不是做什么的注釋。下面我舉個例子說明該如何除去代碼中的注釋。
我們直接看代碼,下面的代碼是我要對注釋進行清除的例子。(這段代碼只是作為一個例子,沒有做過多的考慮。)
1 public String recommendGift(double budget){
2 // get gifts from helper
3 String[] gifts = giftHelper.getGifts();
4 String gift = null;
5
6 for (int i = 0; i < gifts.length; i++) {
7
8 gift = gifts[i];
9
10 // find out if gift already given
11 boolean isAlreadyGiven = false;
12 for (String given : giftsGiven) {
13 if(gift.equals(given)){
14 isAlreadyGiven = true;
15 break;
16 }
17 }
18
19 // calculate rating and budget
20 int x = rating * 200;
21 boolean ok = budget < x;
22
23 // if both conditions satisfy, give it.
24 if(!isAlreadyGiven && ok){
25 giftsGiven.add(gift);
26 // increment maintenance cost of the girlfriend
27 maintenanceCost += budget;
28 return gift;
29 }
30 }
31
32 return gift;
33 }
鄭重聲明:本文版權歸原作者所有,轉載文章僅為傳播更多信息之目的,如作者信息標記有誤,請第一時間聯系我們修改或刪除,多謝。