好代码

   

代码规范!!!

做工单延期项目,先要看系统原先代码,发现非常规范的代码,非常值得学习!!!

   贴出来以便学习:

在每个函数上面都有一大段函数说明!!!并且我看了4048行代码,每个函数都这样,格式也特别整齐!!!,另一个.c文件好几万行代码几乎没有注释,觉得自己本人也看不懂了吧?!!!

   /*

 * 函数名称:GetInterfaceName

 * 函数功能:获取会话操作类型对应接口名

 * 参数说明:

 *   sessionType               会话操作类型

 *   interfaceName             会话操作类型对应的接口名

 * 返 回 值:

 *   UNION_OPERATE_SUCCESS     操作成功

 *   UNION_ARGU_ERR            参数错误

 * 修改历史:

 *   修改日期     修改人       修改内容

 *   2016-11-30   gongf        创建

 */

int GetInterfaceName(char *sessionType, char *interfaceName)

{

    int ret = UNION_OPERATE_SUCCESS;

在函数里面都有关键注释!!!,每个关键的地方都有!

    // 参数有效性校验

    if (sessionType == NULL)

       return UNION_ARGU_ERR;

 

    if (!strcmp("8", sessionType))

       strcpy(interfaceName, "sessionDetail");

    if (!strcmp("9", sessionType))

       strcpy(interfaceName, "sessionDownload");

    if (!strcmp("4", sessionType))

       strcpy(interfaceName, "sessionPlayback");

    if (!strcmp("3", sessionType))

       strcpy(interfaceName, "sessionMonitor");

    if (!strcmp("2", sessionType))

       strcpy(interfaceName, "sessionAbort");

    if (!strcmp("50", sessionType))

       strcpy(interfaceName, "sessionQuery");

 

    return ret;

}

  其实,觉得公司代码不是特别难,熟悉这个流程,就能开发,但开发效率、开发质量,就因人而异!!!记得大学时,做一个课程设计,一个老师说:自己写的代码一定要写备注,要不过段时间,自己都忘了!我在下面心中暗骂:傻逼老师,懂个屁,就那么几行代码忘个毛!!!,现在觉得那时的自己很无知!!!又想起一句话:成长的过程就是觉得自己之前像个傻逼的过程!!!

   细节觉得成败,其实,并没有看过那个写代码的人,虽然不确定他现在是不是大神,但一定会成为大神!!!一个那么注重细节,不成功天理难容!!!

    引以为鉴,不断学习!!!fighting!!!

 

你可能感兴趣的:(好代码)