程式設計師是否有義務做好程式碼的註釋?你做好程式碼註釋了嗎?
關於程式設計,程式碼註釋是一個很重要的部分,從某種程度上,程式碼註釋也反應了一個程式設計師的專業素養,下面我們就來聊聊程式設計師和程式碼註釋的那些事。
一些典型的場景
場景一:某天,一個程式設計師因為一些事情感到心理很委屈,於是他決定,以後寫程式碼的時候,我儘量將註釋寫得模稜兩可,寫得簡單些。
場景二:某天,一個程式設計師因為工作分配不均,然後他決定,儘可能的少寫註釋或者文件。
兩種常見的註釋
//和/**/是我們程式設計師常用的兩種註釋,其中前者是行註釋,後者是塊註釋。
利用行註釋的地方大多是函式或者方法裡面,我們僅僅針對某行做一個簡單的說明。
利用塊註釋的地方大多是,類、方法、函式說明等等,以及方法裡面某個核心的程式碼塊說明。
在一些特殊的開發環境或者業務場景,常見的註釋還有#,比如一些Apache的配置檔案、php的配置檔案、MySQL的配置檔案等等。
想學習c語言c++程式設計的加群:941,636,044,群裡面是有一些資料可以下載幫助大家好好學習程式設計的!
好的註釋作用非常大
其實做好註釋,不管是對你還是對公司來說都是非常重要的。
對於公司,好的註釋以利於程式碼的維護,畢竟你寫的程式碼後面或許是一個程式設計師或者多個程式設計師在維護,如果程式碼註釋風格或者註釋非常混亂,那麼後面的程式設計師在接手你的程式碼時候,維護非常困難,所以一般的程式碼註釋,都是依據某種規範來進行的,比如PHP裡面的PSR規範等。
對於你本人來說,好的註釋,體現了你的職業精神和責任心,因為當領導或者其他程式設計師看到你的註釋之後,就能夠一眼看出你是否負責,是否為公司之後的維護著想。
所以不管怎麼樣,作為程式設計師的我們,應該盡心做好程式碼的註釋。有興趣可以加群哦!
你覺得有必要做好程式碼的註釋嗎?
相關文章
- 趣味橫生的程式設計師搞怪程式碼註釋程式設計師
- 程式設計師應該避免的5種程式碼註釋程式設計師
- 作為程式設計師,有沒有讓你感到既無語又崩潰的程式碼註釋?程式設計師
- CSS程式碼註釋CSS
- php程式碼註釋PHP
- 有趣的程式碼註釋
- 註釋之重——程式設計師與程式碼可維護性程式設計師
- 優秀的程式設計師真的不寫註釋嗎?程式設計師
- 史上最無聊的程式設計師是怎樣註釋程式碼的程式設計師
- 為什麼說程式碼註釋是程式設計師必備的技能?程式設計師
- 請停止程式碼註釋
- javascript如何註釋程式碼JavaScript
- 你寫註釋她幫你寫程式碼
- 請註釋你那該死的程式碼
- 程式碼才是最好的註釋
- 註釋程式碼的13技巧
- bash程式設計 註釋程式設計
- iOS 註釋方法大全 程式碼塊加快捷鍵自定義註釋iOS
- 8個最沒有意義的程式碼註釋
- 寫程式碼前的準備,你做好了嗎?
- Google C++程式設計風格指南(六):程式碼註釋GoC++程式設計
- HTML 程式碼註釋規範HTML
- Java程式碼註釋規範Java
- 39個史詩級奇葩程式碼註釋,程式不會崩,但程式設計師會!程式設計師
- 好程式設計師寫出來的程式碼,就叫好程式碼嗎?你錯了!程式設計師
- Oracle PL/SQL程式碼中的註釋OracleSQL
- 9個最有趣的程式碼註釋
- Pycharm 程式碼註釋風格模板PyCharm
- iOS 註釋方法大全 程式碼塊加快捷鍵註釋iOS
- 你憑什麼做好一個程式設計師?程式設計師
- 【程式設計師之最佳註釋-人人都是昏析師】程式設計師
- android studio和 Eclipse中程式碼的註釋,讓你的程式碼更加AndroidEclipse
- 程式設計師都遇見過什麼奇葩? 客戶: 你程式碼加這麼多註釋有病啊程式設計師
- 竟有如此沙雕的程式碼註釋!
- 10個最“優秀”的程式碼註釋
- java中程式碼的註釋和快捷鍵Java
- 遠離程式碼註釋的 5 個理由
- 五種應該避免的程式碼註釋