软件开发目录规范

软件开发目录规范

1.什么时软件开发目录规范
	为了提高程序的可读性与可维护性,我们应该为软件设计良好的目录结构,这与规范的编码风格同等重要。软件的目录规范并无硬性标准,只要清晰可读即可,一般设置如下
    /bin:可执行的命令
   /core:主程序
   /conf:配置文件
   /log:日志文件
   /lib:库目录
   /db:数据
   README:软件说明
   
关于README的内容,这个应该是每个项目都应该有的一个文件,目的是能简要描述该项目的信息,让读者快速了解这个项目。它需要说明以下几个事项:

1、软件定位,软件的基本功能;

2、运行代码的方法: 安装环境、启动命令等;

3、简要的使用说明;

4、代码目录结构说明,更详细点可以说明软件的基本原理;

5、常见问题说明。
posted on 2021-07-06 22:05  zhifwu  阅读(53)  评论(0)    收藏  举报