c#小灶——4.注釋和代碼規范


為什么要寫注釋?

早上我寫完了代碼,我和我的朋友們都能看懂,到了晚上,我還能看懂,一周后,就只有上帝能看懂了……

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

注釋的原理

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

如何寫注釋

單行注釋

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

多行注釋

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

文檔注釋

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

代碼規范

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

快捷鍵

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


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM