1. 程式人生 > >程式設計師優秀程式碼註釋的5個技巧,谷歌創始人的一段程式碼相當霸氣!

程式設計師優秀程式碼註釋的5個技巧,谷歌創始人的一段程式碼相當霸氣!

程式設計師寫程式碼需要程式碼註釋嗎?對於這個問題不外乎兩種觀點。

一種程式設計師認為,如果類、方法、變數定義準確,程式碼註釋顯得有點多餘。最好的程式碼註釋就是沒有註釋。

另一種程式設計師認為,必須寫程式碼註釋。在這裡相信有許多想要學習前端的同學,關注小編文章最後面文字,可免費領取一整套系統的web前端學習教程!

谷歌創始人布林

別以為你可以理解自己寫的程式碼,過了兩個星期之後,你可能就不知道程式碼是不是自己寫的。

如果是簡單的程式碼,不加註釋情有可原,但是,複雜的程式碼那就必須加註釋了。

下面w3cschool分享程式碼註釋的5大技巧:

1、程式碼註釋最基本的原則

程式碼註釋一定是註明程式碼的目的,而不是程式碼的行為。為何呢?因為通過程式碼我們就可以清楚行為,多加註釋,畫蛇添足。

2、使用空格對齊註釋行

為了方便閱讀起見,程式碼註釋對齊會更好一些。那麼問題來了,是用tab對齊還是用空格鍵對齊呢?

我們都清楚,tab在不同的編輯器和整合開發環境中是不一樣的,所以選擇空格鍵對齊會適合一些。

const MAX_ITEMS = 10; // maximum number of packets

const MASK = 0x1F; // mask bit TCP

3、程式碼少而精

如果說程式碼註釋一定要有,那就就要儘量做到少而精。有些人程式碼註釋寫的跟小說一樣,這後果是相當嚴重的...

4、程式碼“統帥”段落

一些程式設計師習慣將程式碼分成多個“段落”,這是非常要好的一個習慣。

以上是谷歌創始人之一布林的程式碼,他沒有在簡歷中寫待遇,直接在html原始碼註釋:辦公室要大,掙錢要多,幹活要少...

當然,加個程式碼註釋就會錦上添花。比如在段落程式碼前加個註釋。同樣地,就是告訴自己或者維護人員程式碼的意圖。

5、程式碼註釋的精髓

不知道有沒有小夥伴使用下面這種方式寫程式碼註釋,必須要給出大寫的“服”!

如果先想選擇學習前端技術,並且想在這個行業走下去。 1、你要規劃好你未來的學習計劃。 2、學習前端不要急於求成,一定要一點一點的磨練自己的基礎不斷的豐滿自己打磨自己。 3、要有一個良好的學習氛圍。要有一個自己的學習團隊,這樣大家可以融會貫通.有想交流的可以加QQ群:685362217

寫在最後:

很多人都知道我是學全棧的,都天真的以為我有全套的前端、網頁製作等視訊學習資料。我想說你們是對的,我的確有前端的全套視訊資料。