註解在程式中是非常重要的!
試問,你還記得今天午餐的菜有哪些嗎?應該忘了吧?
就連今天發生的事都會記不住,你怎麼會有把握看得懂三個月前你寫下的程式碼呢?

所以註解 很 重 要


C# 官方推薦的風格為:

註解要單獨獨立一行,並且以句號為完結 (這邊我喜歡用半形的 . 來代替)。
在 // 與註解之間,必須插入一個空格。

 
// 這是一段針對程式碼
// 的註解. 
public void Test()
{

}
 

 

以下做法都是不推薦的:

 
//無空格的註解. 

// ********************
// * 特意包起來的註解. *
// ********************

public void Test() // 註解寫在這. 
{

}
 

 

 

其實我個人認為,你的程式風格怎樣並無所謂,就像是口音一樣。 但若是有一個標準在,而大家都可以參照這個標準去執行的話,是不是會讓你在看別人的程式碼,或者別人在看你的程式碼時,可以看得比較舒服些呢?

 

arrow
arrow

    岳 發表在 痞客邦 留言(0) 人氣()