软件开发规范
我们在开发程序的时候,要让程序看起来优雅简洁,让操作代码和阅读代码的人一目了然,并且便于我们操作管理。
所以我们在编写代码的时候就会用到模块的概念,而我们的开发规范就是把具有不同功能的模块进行分类,放在对应的文件夹中,这样就达到
了我上述所说的目的。
如下图所示:
通常我们会把一个程序放在一个大的根目录文件夹中,下面的子文件就是各种不同的功能模块,例如配置文件里面就存入配置类型的模块,主要功能模块放一个文件,还有一些附加在程序上面的如日志、时间等模块。还有固定的诸如bin是作为执行程序文件,最后还要加上对这个程序的功能及介绍的文本。
这样我们一个简单的程序模式就搭建好了,然后我们再一步完善各个文件所要达到的功能。
目录详细的中文释义:
1、bin:启动目录,里面只需要有一个启动程序即可,所有文件的启动都由这里开始
2、conf:配置目录,里面是关于程序运行的所有配置文件,例如路径配置,日志配置等
3、core:主体目录,程序的主体架构,所有的核心逻辑
4、db:文件目录:在程序运行当中需要用到的一些文件
5、lib:工具目录,常用的工具,模块
6、log:日志目录,所有的日志文件
7、readme:关于程序的介绍(相当于说明书)
还有一件我们前期就要做的事情,就是把项目加到环境变量中,因为以后我们的程序都是给用户使用的,所以不能把路径固定死了(我们并不知道用户想使用什么文件路径),这里我们要用到