通過一定的命名規則區分結構變量、函數參數和局部變量,有助於提高程序的可讀性。比如,圖1就是采用筆者所慣用的命名規則所寫出來的程序。這一規則是:
1) 對於結構或C++類中的成員變量,在變量名的後面加一個“_”。
2) 在函數的參數名前加一個“_”。
3) 局部變量和全局變量則不在其前、後加“_”。
example.c
00123: typedef struct dll_node
00124: {
00125: struct dll_node *prev_;
00126: struct dll_node *next_;
00127: } dll_node_t;
00128:
00129: static bool mem_find_neighbor (dll_node_t *_p_node, void *_p_key)
00130: {
00131: maddr_t addr = *(maddr_t *)_p_key;
00132: mnode_t *p_mnode = (mnode_t *)_p_node;
00133: mnode_t *p_next = (mnode_t *)p_mnode->node_.next_;
00134:
00135: if (p_next == 0 || p_mnode->addr_ > addr) {
00136: return false;
00137: }
00138:
00139: // we try to find the node that its address is less than [addr]
00140: // but the address of following node is bigger than [addr]
00141: if ((p_mnode->addr_ < addr) && (p_next->addr_ > addr)) {
00142: return false;
00143: }
00144:
00145: return true;
00146: }
圖1
在很多情形下,需要在函數內部定義局部變量,且有時所定義的局部變量名與函數的傳入參數名可能存在同名。如果不采用命名規則區別函數參數和局部變量,那可能需要定義一個xxx_temp局部變量,如此一來其可讀性不是很好。采用筆者的方法,則如果函數參數是_xxx,仍就可以定義一個局變量名xxx。當程序的讀者看到這兩個變量時,就能快速的知道兩者的功能是一致的,只不過一個是函數的參數,而另一個則是函數內部的局部變量。
本文出自 “至簡李雲” 博客,請務必保留此出處http://yunli.blog.51cto.com/831344/259685