VOIP组编程规范.docVIP

VOIP组编程规范 本规范是为了统一VOIP组内编程风格，作为公司软件编程规范的补充，定义了一些针对VOIP组的编程规范。 代码增加 原则： 1）在要增加的代码前一行和后一行增加相应的注释。 2）注释的描述要有增加人、增加日期、增加原因几个元素。 3）增加人姓名采用姓全拼+名字首字母的组合方式。 4）如果有对应的bugfree问题单，需要在’，’后写明对应的bugfree问题单号。 格式： add by weigy onfor reason, bugfree 1234 add end 举例： void func(int *ptr) { int value; /* add by weigy onfor iuput param check, bugfree 1234 */ if (ptr == NULL) return; /* add end */ value = *ptr; return; } 代码删除 原则： 1）代码删除不采用直接删除原有代码的方式。 2）采用#if 0注释掉原有代码。 3）在#if 0的前一行和#endif的后一行添加注释描述。 4）注释的描述要有删除人、删除日期、删除原因几个元素。 5）删除人姓名采用姓全拼+名字首字母的组合方式。 6）如果有对应的bugfree问题单，需要在’，’后写明对应的bugfree问题单号。 格式： del by weigy onfor reason, bugfree 1234 #if 0 #endif del end 举例： void func(int *ptr) { int value; /* del by weigy onfor iuput param check, bugfree 1234 */ #if 0 if (ptr == NULL) return; #endif /* del end */ value = *ptr; return; } 代码修改 原则： 1）代码不采用直接删除原有代码的方式。 2）采用在原有代码#if 0和#else之间注释掉原有代码，在#else和#endif之间添加修改的代码。 3）在#if 0的前一行和#endif的后一行添加注释描述。 4）注释的描述要有修改人、修改日期、修改原因几个元素。 5）修改人姓名采用姓全拼+名字首字母的组合方式。 6）如果出现多次修改同一个地方的情况，只需要保留原有代码和历史修改注释（历史注释从内到外排列），如果查看具体历史修改代码可通过svn进行比较。 7）如果有对应的bugfree问题单，需要在’，’后写明对应的bugfree问题单号。 格式： mod by weigy onfor reason, bugfree 1234 #if 0 #else #endif mod end 举例： void func(int *ptr) { int value; /* mod by weigy onfor iuput param check, bugfree 1234 */ #if 0 if (ptr != NULL) return; #else if (ptr == NULL) return; #endif /* mod end */ value = *ptr; return; } Source insight设定 原则： source insight和ultraedit统一设定tab键为4个字符。 source insight中右键选择Document Options，在弹出菜单里选中Expand tabs选项框。 souce insight统一设定为等宽模式，切换键为alt+F12。 代码注释描述语言 原则： 代码注释统一用英文描述。 代码移植 原则： 移植别人代码时不需添加本人署名的注释，只需保留移植代码中的原有注释即可。 SVN提交注释 原则： 1）对于bugfree上有对应问题单的svn提交记录，注释要写明对应的bugfree号；bugfree与问题单号之间是空格，而问题单号与reason之间是’：’分隔。 2）对于bugfree上没有对应问题单的svn提交记录，注释只需写清reason即可。 尽量一个svn提交记录只修改一个问题，如需在一个svn提交记录内修改多个问题的，要将多个问题描述清楚，中间用’；’分隔。 格式： 1) svn ci –m “bugfree1234: reason” …… 2) svn ci –m