C语言项目开发-项目架构和编程命名规范-阿里云开发者社区

开发者社区> 韩俊强> 正文

C语言项目开发-项目架构和编程命名规范

简介: 一个项目的流程: 1、公司市场人员与客户交流,了解客户、引导客户使用公司最优资源并产出一份市场需求文档 2、公司需求人员(BA)与客户交流,了解客户需求并产出一个软件需求文档 3、项目经理、开发小组成员、需求人员(BA)一起开一个需求评审会议,对不合理的地方,    打回给BA,再由BA与客户沟通 4、程序员接到和充分了解软件需求文档后产生软件设计文档(包括概要设计文档和详细设计文档,    涉及到数据库的还需要进行数据库的设计) 5、程序员根据设计文档进行编码、调试、打包发布。
+关注继续查看
一个项目的流程:

1、公司市场人员与客户交流,了解客户、引导客户使用公司最优资源并产出一份市场需求文档

2、公司需求人员(BA)与客户交流,了解客户需求并产出一个软件需求文档

3、项目经理、开发小组成员、需求人员(BA)一起开一个需求评审会议,对不合理的地方,

   打回给BA,再由BA与客户沟通

4、程序员接到和充分了解软件需求文档后产生软件设计文档(包括概要设计文档和详细设计文档,

   涉及到数据库的还需要进行数据库的设计)

5、程序员根据设计文档进行编码、调试、打包发布。如果编写的函数库,还可能编写一份接口使用文档,

   如果程序是直接运行的软件,还需要编写一份用户使用手册,包括各种操作步骤和配置参数说明

6、软件发布后,客户可能进行一段时间的测试、或者将其投入运营。这期间会发现一些问题,还需要

   程序员进行修复,这已经进行维护阶段了,这个阶段的周期很长,可能5年,也可能10年,或者更长

 

之所以写了软件项目的流程,只是想强调,软件最花费时间的是维护阶段。这个阶段,维护人员可能是

原来的开发人员,但更可能是非原开发人员来维护的。在中国,IT从业人员流动性太大,一个项目的维护

更可能是之前没接触过这个项目的程序员。如果这个时候,文档不齐全,将是一件很蛋疼的事情。

对一个程序员来说,这还不是一个最悲剧的事情。程序员要维护项目,最终还是要阅读项目源代码,

此时如果项目架构设计得很糟糕和代码写得乱七八糟的,想必维护人员在修改项目代码时肯定会咒骂

原来的架构师和开发人员,正因为架构师的低水平设计,业务代码、数据库代码、控制代码深深耦合在

一起,改动一处总害得别人担惊受怕,这因为开发人员没有添加该有的注释,命名的变量不能让人见命思意,

编写的代码过渡冗余,重复的代码多处使用,让维护程序员改了这个地方却不知道还有一个地方有相同的代码

没有修改,此时难保证维护程序员不砸了他的电脑。

 

每个公司都有自己的一套项目流程,自己的编程命名规范,

渐渐的,慢慢也形成了自己的编码风格和命名风格。在此总结一下。这里主要总结C语言的,

因为Java在这方面较C、C++做得相对够好,就不啰嗦了,不过都有参考价值。

1、尽量不用全局变量

  全局很容易破坏软件的结构,增加代码的耦合度,将模糊业务代码、数据库代码、控制代码的界限,

  害得维护人员在阅读代码时,第一要务就是要追踪全局变量在哪里,由于设计得不好,基本项目的

  所有源代码文件都涉及修改了全局变量,这一追踪下来,不是一天半会能够摸索清楚你要了解的某个

  功能,尽管这个功能很小,你还是要看完这整个项目,太浪费时间了,不值得啊。

2、少用全局变量

  有些项目由于硬件资源的限制,比如嵌入式开发,你不得不使用全局变量。在这种不可避免的情况下,

  我们只能尽量减少使用全局变量。

3、别忘记加上static

   如果你使用到的全局变量仅仅是某个源文件(模块)使用到,别忘记给这个全局变量加上static。

4、别忘记加上const

  如果你设计的接口(函数)有入参,而你不想修改这个入参,别忘记加上const。

5、明确哪些结构体、枚举、联合体、宏、常量需要全局使用,哪些需要全局使用

  如果有的结构体、枚举、联合体、宏、常量仅仅是某个模块需要使用,就没必要放置在公共的头文件中

  如果结构体、枚举、联合体是需要公用的,就要考虑是否需要仅仅在公用头文件中声明,在某个源文件中

  实现,这样可以避免某些类型重复定义的错误。

6、让C代码带上面向对象的思想

  不像C++这样即面向过程又面向对象的语言,更不像Java、C#这样完全面向对象的语言,C语言仅仅是面向

  过程的,但是我们可以为C语言设计的项目插上面向对象的翅膀。

  1、面向对象的命名

               如我们在开发一个GUI库,设计到GUI的初始化、加载字体、设置背景色、设置前景色等等操作,

    如果是没有代码面向对象的命名,可以这样:

    Init、LoadFont、SetBgColor、SetFgColor

    如果是带上面向对象的命名,则可以这样:

    Gui_init、Gui_LoadFont、Gui_SetBgColor、Gui_SetFgColor

    这样命名有个很好的好处,便于程序员记忆,我们在想到需要用到GUI的接口时,只需要打上Gui,

    好的集成开发环境就能快速提示所有的GUI库函数,这无论对新接触GUI这个库,还是熟悉GUI库的

    老牛们大大的提高效率。

  2、为仅在一个模块内使用的全局变量加上static

    配合【1】的命名、Gui_Init、Gui_LoadFont、Gui_SetBgColor、Gui_SetFgColor等函数操作这个模块内的全局变量,

    这个时候,GUI犹如一个类,模块内的全局变量犹如C++、Java、C#等面向对象语言的GUI类的成员变量,Gui_Init等GUI库函数

    犹如GUI类的成员函数。

  3、设计纯洁的接口

    如代码:

    void func(int *iResult)

         {

              *iResult = g_Val*10000 + 1000; // 使用了全局变量参数复杂运行的代码

        }

    以上的代码就需要以来g_Val这个全局变量,这种写法已经污染了这个接口

   如果是纯洁的接口,应当

       void func(int *iResult, const int iVal)

         {

              *iResult = iVal*10000 + 1000;

    }

    调用时:

    int iResult,g_val;

    func(&iResult, g_Val);

    这样这个函数就不至于严重以来全局变量,你可以传全局变量进来,也可以传局部变量进来,

    纯洁的接口并不关心这个。

7、命名规范

   1、全局变量加前缀g_,如定义一个全局变量int g_iVal;

   2、static变量加前缀s_,如定义一个模块全局变量static int s_iVal;

   3、结构体变量加前缀st_,如COMM_PARA是一个已经定义好的结构体,则COMM_PARA stCommPara;

   4、枚举变量加前缀e,如ENUM_SEX是一个已经定义好的枚举,则ENUM_SEX eSex;

   5、int类型变量加前缀i,如int iRet;

   6、unsinged int类型加前缀ui,如unsigned int uiRetCode;

   7、float类型变量加前缀f,如float fVal;

      其实有了double类型,可以不用float,就尽量使用double。

   8、unsinged float类型变量加前缀uf,如unsinged float ufVal;

   9、double类型变量加前缀d,如double dVal;

   10、unsinged double类型变量加前缀ud,如unsinged double udVal;

   11、short int类型变量加前缀si,如short siVal;

   12、unsinged short类型变量加前缀usi,如unsinged short usiVal;

   13、如果定义一个bool类型的变量加前缀b,如int bFlag;char bFlag;

   14、如果定义的是一个字符串类型char[],

      如果字符串是需要以0结束符的字符串,则char szCountry[11+1];

      这种情况下的字符数组的大小写法是字符个数+1的

      如果字符串不需要以0结束符的,则char sCountry[11];

   15、如果定义的是一个字符串类型char *,

      如果字符串是需要以0结束符的字符串,则char pszCountry[11+1];

      这种情况下的字符数组的大小写法是字符个数+1的

      如果字符串不需要以0结束符的,则char psCountry[11];

   16、如果是一个指针类型,

      如果指针变量是通过malloc动态获取内存的,则int * piValPtx;

      Ptx代表这个变量是需要动态释放内存

      如果指针变来那个不是动态获取内存的,则int piValPtr;

      如果带上了Ptr或者Ptx的后缀,则前缀的p可省略

   17、项目的命名

      在公司内唯一

   18、文件的命名

      如果某些文件是项目唯一使用的,文件名称加上“项目名称简写”+ “_“作为前缀

   19、接口函数命名

      如果写的是库,则库接口则应该是库名称加上“项目名称简写”+ “_“作为前缀

   20、防止头文件重复使用宏命名

      项目名称简写”+ “_“ + “文件名" + “_“ + “H"


更新关注:http://weibo.com/hanjunqiang  新浪微博!手机加iOS开发者交流QQ群: 446310206


版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
AB RsLogix5000 PLC第三方模块MVI56的编程开发
  在做济钢项目的时候遇到一个很大的挑战,第一济钢要求采用AB的RsLogix5000系列,第二该系统需要联入本公司自己生产的红外测位系统。
619 0
大型项目开发: 隔离 (《大规模C++程序设计》书摘)
书中第六章 隔离。 主要在撰述什么需要定义在头文件?什么应当移到编译单元中? 核心仍然是先区分接口定义与实现细节。
877 0
Go语言与数据库开发:01-02
接下来,开始了解go语言的程序结构,基础要打牢。 Go语言和其他编程语言一样,一个大的程序是由很多小的基础构件组成的。变量保存值,简 单的加法和减法运算被组合成较复杂的表达式。基础类型被聚合为数组或结构体等更复杂的 数据结构。
1350 0
17.Linux shell编程(通过Makefile看Android.mk文件)
(创建于2018/2/11 上午8:12:32) Makefile文件 //递归展开式,可以引用还没有定义的变量,展开是引用时展开 1 str1=$(str2) ...
1119 0
【汇编语言/底层开发】6、程序中包含多个segment
众所周知的是,我们所开发的应用程序需依赖于操作系统运行,因此应用程序所使用的内存空间必须是安全的,不能与操作系统和其他应用程序相重合。因此,应用程序所需要的空间应当通过操作系统申请。
761 0
+关注
韩俊强
高级软件开发工程师, 博客专家, 阿里云MVP, CSDN十大博客之星, 十佳专栏 。
494
文章
7
问答
文章排行榜
最热
最新
相关电子书
更多
《2021云上架构与运维峰会演讲合集》
立即下载
《零基础CSS入门教程》
立即下载
《零基础HTML入门教程》
立即下载