好的源代码管理习惯

1.把不同功能的代码放在不同的文件中,并且把必要的函数放在对应的头文件中

      建议把源文件里供其他软件模块使用的的函数放在头文件中,把仅供本模块使用的函数和定义放在源文件中,不必单独列出。

例如

有两个软件模块module1和module2,module1调用module2,module2调用调用了函数a(),b(),c(),此时,仅需要把module2的函数声明写在头文件就可以,而a(),b(),c()这三个函数仅写在module2同一个源文件就行,不必单独写在module2的头文件中。

2.对软件模块划分层次

 

  软件模块之间按照功能,都会有一定的层次关系,最好按照软件模块的层次关系,为每个模块建立目录,形成一个有次序的软件目录结构,并且在每个目录下都建立一个Makefile文件,管理本模块的代码文件,这样看起来比较繁琐,目录很多,但好处是显而易见的,提高了软件模块之间的相互独立性,对开发调试和维护升级都很有好处。

  例如,一个软件要提供一个支持第三方插件的功能,可以在代码目录里增加一个plugin目录,在plugin目录下为每一个插件建立目录,这样从目录上就可以看出代码的功能,不仅方便管理,也有利于调试。

 

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
操作平台:windows 9x/me/2000/xp/2003最低安装需求:16MB内存 功能限制:无文件详细说明:----------★ CodeHelp是专门为我们程序员设计的一款源代码管理软件。它能方便的管理您在编程和学习有用的源代码,减少经常到处查找资料的劳动,节省您在开发的时间和精力。★ 知识管理越来越被大家所重视,源代码也应该做为一种知识资源,纳入知识管理体系去。利用CodeHelp,可以方便的管理你的各种技术资料和源代码。 ★ CodeHelp 支持多个数据库文件,能够新建数据库、打开数据库、压缩和备份数据库。★ CodeHelp 以目录树来管理代码文件,你可以自由定义目录,并能够自由拖拽、移动、修改,支持无限分支延伸。采用分段读入方式,能支持超大的目录树。★ CodeHelp 支持“语法突出”方式显示代码,目前支持 C/C++、Pascal、Java、VB.Net、XML、HTML等方式,您也可以按照规则自己添加“语法突出”格式。★ CodeHelp 采用 TabView 来显示多个源代码文件,查看起来非常方便。★ 源代码编辑器多数没有自动换行功能,CodeHelp 的源代码编辑器增加了手动格式化功能,能够把所选文字格式成多行或一行文本。★ CodeHelp 能够为每个文章添加多个附件,并能够在临时目录打开附件、导出附件。★ CodeHelp 能够在数据库按标题查找文章,并支持书签功能。 CodeHelp 2.0 新增功能·支持多个数据库文件,能够新建数据库、打开数据库、压缩和备份数据库。·增加按标题查找文章功能·增加书签功能·用户自己添加“语法高亮”定义文件,从而在CodeHelp增加自己的语法高亮格式。·源代码编辑器增加手动格式化成多行或一行的功能。·源代码编辑器增加查找功能·能够为每个文章添加多个附件,并能够在临时目录打开附件、导出附件。
PerCDM2013的实现的全部 (2012年2月14日12:57:53 改名为PerCDM2013) 2013年1月27日20:07:48 PerCM2013是我对PerCM系列软件的重,计划利用1月27日至2月4日这段时间进行设计实现。因为手头还有一个警报发放系统需要完工,所以选择了一直在使用的C#系列进行实现。为了强化前一段时间所做的努力,需要有“项目系统分析”,对技术的选择也要能够大胆有规划。这样,几个软件实现之后,才能够全面地提高能力。 需要研究的技术以下几类 1、现有的代码管理软件的组织构造,自己合理联想; 2、ICSharpCode.TextEditor的重新研究,加速合成; 3、sqlite数据库的使用; 4、自动更新技术的研究; 5、界面库的引入。 立刻行动起来吧! 对陈灯代码管理软件的分析: 这个软件的最大的体会就是“该实现的都已经实现了”。具体以下几点: 1、代码录入模块,可以快捷键进行,其实按照“代码语言”“代码分类”和“关键字”三类就可以区分代码; 2、代码查阅模块,可以查看“最近入库”的和“最近使用”数据,并且数据的查阅方法,非常好。 3、广告,可以一样的方式来打; 4、导入导出代码库其实是一个隐形的亮点,这个系统的数据融合是非常好的;可以加上数据库加密的方法; 5、许多东西都可以设置 包括数据库位置、密码、热键、开机是否启动等等。这里的安全操作密码是为了防止错误删除,可以采用。 2013年1月28日8:36:36 主要界面分为三个部分,一个是数据的获取,一个是数据的查阅(模仿陈灯),此外还包括一个配置界面。采用统一的标准的界面配置,加上一些个人控件的小玩意,保证高效和美观。 2013年1月29日8:12:54 这个程序,玩的就是数据库。在目前时间紧张的情况下,我把零散的时间集合起来,研究一下sqlite. 发现有一个现成的库可以来引用“SQLite ADO .NET”; 2013年1月30日7:35:54 SQLite ADO .NET的引入非常简单,直接把.dll引入,让命名空间来调用就可以了。但是,相比较用的很习惯的sqlserver,这个调试起来还是复杂了一点。 现在编这种带数据层的代码,已经比较有经验了。 2012年2月2日11:18:37 即使是很简单的功能,也可能需要长时间的编。积累就因此非常的重要。 而且有一点,我一定不要忘记,那就是我现在所编的代码,都是高层的代码,也就是说,没有杀手锏。但是方法是相同的,总结是相通的,这一点一定要铭记在心。 2012年2月14日12:52:26 这里有一点启示:即使是那些司空见惯的功能,去实现也可能会耗费相当长的时间。这里,对于软件的积累就相当重要了。 我对未来这个PERCDM的规划,从自己的需求开始: 1、要能够完全实现通过分析程灯那个软件得出的东西; 2、稳定大方,特别是代码高亮的那个地方; 3、具备codelibary的那种管理附件的功能; 4、具备局域网管理功能,为未来应有于内网服务。 5、能够有专门的用来文档的地方,不一定会很完善,但是有开始,软件的名称也改变为 perCDM 不去做的事情:、 1、类似word的这种复杂文档控制; 2、robbing,界面是要简单; 3、高强度的复制。 2012年2月15日8:34:12 对于几个问题的研究: 1、如何实现附件的功能? 现有的系统都是放到数据库(而不是存放文件路径),这个样子可以保证系统的高度整合。其使用sqlite的那个系统将文件(可能还有其他的什么东西)放到了一个单独的数据库文件,是值得借鉴的。 2、CINtanotes的实现可以汲取的地方 这个样式是我一直想实现但是实现不了的。但是确实很重要,可能还是要多问人,合理利用资源; 注意它的那些搜索的小物件,在大体实现的基础上,这些细节就是专业的开始。 数据库设定 有岂止是复杂一点两点。很多东西现在是没有办法理解是为什么的,但是这证明即使是看起来很简单的东西,也可能有复杂的原理,不可小视。 这里还有一个类似的实现了的软件。 需要注意的是,这种全本浏览的方式,也可能是整理的方式,也是我所需要的,就是能够对自己所掌握的知识进行一个系统的整理,这个目前不去实现。 如果简化成为这样一个状态,perCDM不但可以搜索代码,而且可以同时搜索输入的文档(甚至文档就作在其),我想可以首先从简单的模式去实现,这是一个我需要的模式。 3、文档模式,对apose进行了初步的分析。这个收费软件想使用起来需要更多的研究; 4、备份,导入导出以及网络热备 热备是备份的升级。首先从本机备份开始来做。 这个需要数据库有相关设定,时间等,我相信自己能够完成,还有对时钟的控制,这个热备也是需要的; 那么导入导出,就需要使用到GUID,可能还不止一个数据库。 网络热备,我更倾向于建立服务器,基于我比较扎实的网络通行模型,实现这样的一个系统。 2012年2月18日18:59:41 随着编几个类似程序并且不断总结反思,的确在winform程序编的能力上有了一定的提高,对于解决问题,开始有了独立的思考。但是必须认识到自己所处于的不利状态,所以集聚所有的资源,去开发一个有用好用的程序非常重要。 测试是非常重要的。测试不仅包括可以使用的测试,也应该包括是否好用的测试和能否达到目的的测试。 在使用和测试之间,如何去取得平衡?我这里需要不断地对代码进行重构,并且做出有足够挑战价值的工作。 经过一段时间的修改,现在代码很糟糕,是到了改对其进行修整的时候了。好看的代码,将是更为宝贵的财富。更何况这里编的是用于资料统计的工具了? 进行重构的时候,发现自己还是有想法的。的确创新不是无本之源,艰苦的工作是一定创造所需要的。 2012年2月19日20:53:12 今天对于控件的研究上了一个新台阶,回首逐渐实现这个想要的效果的过程,感到很充实。首先是经过多方面的资料搜集,才发现flowpanel可以实现我所需要的效果。然后是基于以前的自定义控件编基础,出了能够解决一定问题的控件。然后是不断精益求精,现在在现实效果上面已经差强人意了,缺乏的是效率问题,这个需要继续研究。 现在看来,自定义控件的确是一个解决许多问题的方法,现在能够把click事件都统一的处理起来,程序已经逐渐像样子了。这个记忆比较深刻,应该是忘不掉了,这其实也就教育自己:去追求,才能够有收获。下一步是数据的融合问题。送自己一句话:“不要让这个世界的复杂性阻碍你前进,要成为一个行动主义者”。需要做的实在是太多了,立刻行动吧。 2012年2月26日21:55:32 上个周末回了次盱眙,这几天工作冲突太大,而且手头出现了一个复杂的webapp,现在不是很在状态。但是设计需要继续做下去,只有顶住了,坚持住了,才可能会获得进步。 现在需要解决的是热备问题。热备两个思路,一个是直接把.db拷贝过去,一个是在数据库设定“dirty”位,定时对所有”dirty”进行处理。两者相比,前者低效但是易行后则较难实现一点。通过一定的实验,发现数据库使用过程,.db是可以被拷贝的,而且速度不慢。所以首先采用第一种思路。 这里就需要percmserver,白手起家,如何开始?还是需要循序渐进,首先从最简单的开始。后期,可以将这个服务器设计成多用户的(那就是另一个话题),首先需要把网络的机制引入进来,并发现和解决问题。由于是局域网内文件传输,所以先采用udp的方式(如果我采用第二种方法,可以配套采用tcp的方式)。那么问题分解如下: 1、局域网udp传输文件; 2、加入一些东西,判断当前数据库是否需要被热备(一般来说是时间) 3、如何从服务器将被热备的数据库拷贝回来(比如我换一个机器); 2012年2月29日8:02:30 现在基本把“热备”的机制加入了进去,但是由于对热备的机制认识不是很全面,所以可能没有完全实现这个功能。我认为现在是需要把这个程序拿出来,给更多的人使用,进行发现问题的时候了。 2013年3月24日 10:29:36 利用休假的最后时间把这个软件在网络上发布。想获得许多人的认同是困难的,但是至少这里有一个开始: 代码收录界面: 代码搜索界面,使用了较多的自定义控件: 丰富的配置界面: 具备热备功能: 好了,就是这些。我希望这个软件能够给大家的日常工作或者学习带来方便。需要代码或者有问题讨论,请邮jsxyhelu@gmail.com,一定给出满意答复! Jsxyhelu 二〇一三年三月二十四日 10:41:21
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

ANTRK

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值