不要排斥中文註釋

  項目的代碼註釋,我們並不限定只能使用英文,對某些對較爲複雜算法的解釋,用英文會帶來理解上的問題,用中文註釋更易理解,一般簡單易懂的可以用英文,註釋最重要的是能夠看懂,看不懂,用多國際化的語言都不頂用,代碼不只是給自己看的。而且在存在複雜語句的時候,如果英文註釋各種語法不通,就更是鬧笑話了。

  當然,如果你對自己的英語自信,可以使用全英文,但是請也要考慮代碼的後繼維護者的語言水平。

  在此只是聲明:

  不要排斥中文註釋!

  註釋的首要原則,是易於理解!

  一種情況下例外,當你開發一個開源項目的時候,還是用全英文吧,得保證全世界所有人都能看懂。

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