c#小竈——註釋和代碼規範

c#小竈——註釋和代碼規範
爲什麼要寫註釋?
早上我寫完了代碼,我和我的朋友們都能看懂,到了晚上,我還能看懂,一週後,就只有上帝能看懂了……

將來我們寫的代碼量是很大的,代碼又不像我們自然語言這麼好理解,可能過段時間我們就不認識自己的代碼了,所以我們要養成寫註釋的好習慣。
團隊合作當中,寫了註釋更容易使別人讀懂你的代碼。
註釋的作用除了解釋說明,還有一個比較常用,因爲註釋不被編譯的特性,我們經常會把一些暫時用不到的代碼註釋掉,這樣的話如果突然需要就可以拿來用了。如果刪掉了,再用就只能重新寫了。
註釋的原理
  我們在代碼當中寫註釋,只會方便我們理解,真正編譯的時候,編譯器會跳過註釋的部分,所以寫註釋不會對我們的程序產生任何影響。它只是給人看的,機器不看。

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

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

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

代碼規範
經過這幾天的學習,你們應該能發現我的代碼都是有縮進的,如果不縮進行不行?從技術上說,行。
你們也能看到我都是一行只寫一條語句,那我寫多條行不行?從技術上說,也沒問題。
可是你想過嗎?將來我們要寫的代碼是很多的,所以一定要規範,這樣將來讀起來才更容易,維護起來也更簡單。所以一定要有縮進,要層次分明,一行只寫一條語句,上下的大括號要對齊,變量名字要見名知意……
養成好習慣,從現在做起。
快捷鍵
快速排版代碼 ctrl+K接着ctrl+D。對齊啊縮進啊什麼的都要規範的,vs提供了一個功能就是快速排版,如果代碼亂了按一下快捷鍵,就有條理多了。
註釋所選代碼 ctrl+K接着ctrl+C。先選中需要註釋的代碼,一行或者多行,然後使用這個快捷鍵。相當於在選中的每行代碼前自動添加//。
取消註釋代碼 ctrl+K接着ctrl+U。如果有批量被註釋的代碼,用此快捷鍵相當於去掉選中的每行代碼前的//。
原文地址https://www.cnblogs.com/hmswt/p/11298986.html

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章