iT邦幫忙

2019 iT 邦幫忙鐵人賽

DAY 7
0
自我挑戰組

易讀程式之美學系列 第 7

富含資訊的名稱--利用名稱格式加入更多意義

  • 分享至 

  • xImage
  •  

底線、破折號以及大寫等方式都能夠在名稱加入額外資訊。

static const int kMaOpenFile = 100;

class LogReader{
  public:
    void OpenFile(string local_file);
    
  private:
    int offset_;
    DISALLOW_COPY_AND_ASSIGN(LoadReader);
};

類別成員函數似區域變數,但必須以底線結尾。例如,在一個很大的方法中看到這行程式:

stats.clear();

如果使用member_ 慣例,就能夠很快知道「stats一定是區域變數,不然就會命名為stats_」

其他排版範例

<< JavaScript:優良部份 >>書中,作者建議:

  • 「建構子」(在使用new時會呼叫的函數)應該以大寫開頭,而一般函數則以小寫開頭:
var x = new DatePicker();  //DatePicker()是個「建構子」函數
var y = pageHeight();   //pageHeight()是一般函數
  • 呼叫JQuery函式庫時,常用慣例是將JQuery的結構都加上$符號:
var $all_image = $("img");  //$all_image是個JQuery物件
var height = 250;  //height不是個JQuery物件
  • 在CSS中為HTML標籤指定id或class屬性時,可以限定id只使用底線,而類別則用破折號區分個別單字:
<div id="middle_colum" class="main-content">...

讀者或所屬團隊可以自行決定是否採用這些慣例,不管是否採用,重要的是在所有專案中維持相同的慣例。

Reference

  • <<易讀程式之美學-提升程式碼可讀性的簡單法則 >>(The Art of Readable Code)

上一篇
富含資訊的名稱--名稱該有多長
下一篇
不被誤解的名稱--1
系列文
易讀程式之美學30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言