软件开发目录规范
软件开发目录规范
功能目的
为了提高程序的可读性与可维护性,我们应该为软件设计良好的目录结构,这与规范的编码风格同等重要。软件的目录规范并无硬性标准,只要清晰可读即可
conf:存放配置文件的文件夹
core:核心业务代码,存放业务逻辑相关代码
interface/api:存放接口文件,接口主要用于为业务逻辑提供数据操作
db:存放操作数据库相关文件,主要用于与数据库交互
lib:存放程序中常用的自定义模块
log:存放日志文件
bin:存放启动文件
run.py: 程序的启动文件,一般放在项目的根目录下,因为在运行时会默认将运行文件所在的文件夹作为sys.path的第一个路径,这样就省去了处理环境变量的步骤
setup.py: 安装、部署、打包的脚本。
requirements.txt: 存放软件依赖的外部Python包列表。
readme:项目说明文件
#readme文件说明
1、软件定位,软件的基本功能;
2、运行代码的方法: 安装环境、启动命令等;
3、简要的使用说明;
4、代码目录结构说明,更详细点可以说明软件的基本原理;
5、常见问题说明。
详细介绍可以参考小猿取经和官网
https://www.cnblogs.com/xiaoyuanqujing/articles/11640992.html
作者:池木
出处:https://home.cnblogs.com/u/a736659557/
本文版权归作者和博客园共有,欢迎转载,但未经作者同意必须保留此段声明,且在文章页面明显位置给出原文连接,否则保留追究法律责任的权利。