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

一个项目的流程:

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

时间: 2024-08-03 01:15:00

C语言项目开发-项目架构和编程命名规范的相关文章

项目开发-项目是如何实现的?或者我问的只是模块化的开发?

问题描述 项目是如何实现的?或者我问的只是模块化的开发? 大家看看我的理解是不是对的哈,欢迎批评指正 我的理解是:一个大的软件项目分成几个或几十个模块,每个模块实现一种功能,模块内有多个功能函数,不管是库函数还是自定义函数,通过这些函数完成各种功能,然后又架构师将这些模块拼接起来,形成一个相互关联,整体可用的软件,大概流程是不是这样的啊?

仿百思不得其姐项目开发(粗略笔记,后期规范排版和更新)

 

Swift项目开发实战-基于分层架构的多版本iPhone计算器-直播公开课

Swift项目开发实战-基于分层架构的多版本iPhone计算器-直播公开课 本课程采用QQ群直播方式进行直播,价值99元视频课程免费直播.完整的基于Swift项目实战,手把手教你做一个Swift版iPhone计算器.(直播过程也有惊喜!)直播QQ群:362298485(直播时点击群视频即可进入直播课堂)直播时间:8月26日(周二),9月2日(周四),每天20:00-22:00欢迎咨询客服QQ:1575716557直播后希望继续深入学习了解本课程可在51CTO学院购买本课程,定价99元.购买课程更

实战项目开发细节:C语言分离一个16进制数取出相应的位1或0

最近在公司开发一个关于钢琴的PCBA项目,项目大概是这样的,完成各种功能的测试,准备去工厂量产的时候可以通过软件快速甄别硬件是否短路,断路等问题.       其中,甄别好坏的方法是通过比如按键,或者其它的操作然后响应音频信号的输出来甄别的,那到底原理是怎么样的呢?       音频信号定制为如果是0则输出1000hz,如果是1则输出3000hz.       音频信号是一个16进制数,比如0xfd----->1111 1101        那么它的输出应该是这样的,从左边最高位开始,输出30

软件工程—思考项目开发那些事(一)

阅读目录: 1.背景 2.项目管理,质量.度量.进度 3.软件开发是一种设计活动而不是建筑活动 4.快速开发(简单的系统结构与复杂的业务模型) 5.技术人员的业务理解与产品经理的业务理解的最终业务模型 5.1.产品的业务理解(业务流程.数据流程及场景) 5.2.技术人员的业务理解(领域模型.设计模型.抽象建模) 6.技术债务(腐烂的遗留代码) 7.软件项目管理与软件工程的鸿沟(项目管理得有语境上下文) 7.1.软件项目管理其实应该多去重视一些技术层面的管理 7.2.软件工程才是指导软件开发的科学

J2EE文萃:做好网站开发项目需求的分析

j2ee|项目 一个网站项目的确立是建立在各种各样的需求上面的,这种需求往往来自于客户的实际需求或者是出于公司自身发展的需要,其中客户的实际需求也就是说这种交易性质的需求占了绝大部分.面对对网站开发拥有不同知识层面的客户,项目的负责人对用户需求的理解程度,在很大程度上决定了此类网站开发项目的成败.因此如何更好地的了解.分析.明确用户需求,并且能够准确.清晰以文档的形式表达给参与项目开发的每个成员,保证开发过程按照满足用户需求为目的正确项目开发方向进行,是每个网站开发项目管理者需要面对的问题.就这

ASP.NET 3.5企业级项目开发

第一章:企业级项目框架概述 前言:之前也看过大家在谈架构,谈分层,谈模式.对一些问题,大家也各抒己见,确实不确.但是 不管怎样,我们最终还是要在我们的项目中真正的去实现谈论的这些方法,方法谈了就要用,要实践才有 价值.而且代码是最没有二义性的,所以,本系列将一步步的带领大家开发一个正真的企业级项目. 其中融合了分层架构,设计模式以及很多OO的设计思想.而且大家也可以看到,我们不是"为了 模式而模式",而是一种自然过渡的思想.本系列文章不是为了别的,只是希望可以给大家带来一点 点的帮助.

企业IT项目开发之七宗罪(下篇)

即使没有翅膀,心......也要飞翔! 在新年前一天预祝大家新年好,在新的一年里工作顺利,身体健康. 前一阵公司给我下达了任务,一直在忙着打造面向SAAS的企业级微信平台,彻底实现零代码配置,小小一个微信,当面向企业级而且是SAAS时,呵呵,还真的有许多需要注意的地方,非常感谢公司内最强的业务架构师我们的大姐设计出来这么优秀的一款全动态微信业务.所以写完了中篇,一直没时间来得及写下篇. 下篇的开头,大家也看到了标题:即使没有翅膀,心也要飞翔!!! 为什么提这个标题呢?企业IT项目开发之七宗罪上.

如何做好网站开发项目的需求分析

一个网站项目的确立是建立在各种各样的需求上面的,这种需求往往来自于客户的实际需求或者是出于公司自身发展的需要,其中客户的实际需求也就是说这种交易性质的需求占了绝大部分.面对对网站开发拥有不同知识层面的客户,项目的负责人对用户需求的理解程度,在很大程度上决定了此类网站开发项目的成败.因此如何更好地的了解.分析.明确用户需求,并且能够准确.清晰以文档的形式表达给参与项目开发的每个成员,保证开发过程按照满足用户需求为目的正确项目开发方向进行,是每个网站开发项目管理者需要面对的问题. 一.那些人应该参与