1. 程式人生 > >c#小灶——註釋和程式碼規範

c#小灶——註釋和程式碼規範

為什麼要寫註釋?

早上我寫完了程式碼,我和我的朋友們都能看懂,到了晚上,我還能看懂,一週後,就只有上帝能看懂了……

  1. 將來我們寫的程式碼量是很大的,程式碼又不像我們自然語言這麼好理解,可能過段時間我們就不認識自己的程式碼了,所以我們要養成寫註釋的好習慣。
  2. 團隊合作當中,寫了註釋更容易使別人讀懂你的程式碼。
  3. 註釋的作用除了解釋說明,還有一個比較常用,因為註釋不被編譯的特性,我們經常會把一些暫時用不到的程式碼註釋掉,這樣的話如果突然需要就可以拿來用了。如果刪掉了,再用就只能重新寫了。 

註釋的原理

  我們在程式碼當中寫註釋,只會方便我們理解,真正編譯的時候,編譯器會跳過註釋的部分,所以寫註釋不會對我們的程式產生任何影響。它只是給人看的,機器不看。

如何寫註釋

單行註釋

單行註釋的寫法是//,//後面的內容都不會被編譯

多行註釋

多行註釋的寫法是以/*開頭,以*/結尾,它們中間的內容不會被編譯。

文件註釋

文件註釋這個比較特殊,因為它的目的是生成一份程式的說明文件,所以它會被編譯,但是不會被執行。單行註釋和多行註釋可以寫在任何地方,文件註釋只能寫在類和方法的前面。

程式碼規範

經過這幾天的學習,你們應該能發現我的程式碼都是有縮排的,如果不縮排行不行?從技術上說,行。 你們也能看到我都是一行只寫一條語句,那我寫多條行不行?從技術上說,也沒問題。 可是你想過嗎?將來我們要寫的程式碼是很多的,所以一定要規範,這樣將來讀起來才更容易,維護起來也更簡單。所以一定要有縮排,要層次分明,一行只寫一條語句,上下的大括號要對齊,變數名字要見名知意……  養成好習慣,從現在做起。

快捷鍵

  1. 快速排版程式碼 ctrl+K接著ctrl+D。對齊啊縮排啊什麼的都要規範的,vs提供了一個功能就是快速排版,如果程式碼亂了按一下快捷鍵,就有條理多了。
  2. 註釋所選程式碼 ctrl+K接著ctrl+C。先選中需要註釋的程式碼,一行或者多行,然後使用這個快捷鍵。相當於在選中的每行程式碼前自動新增//。
  3. 取消註釋程式碼 ctrl+K接著ctrl+U。如果有批量被註釋的程式碼,用此快捷鍵相當於去掉選中的每行程式碼前的//。