【编程好习惯】通过命名规则区分变量

通过一定的命名规则区分结构变量、函数参数和局部变量，有助于提高程序的可读性。比如，图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