码迷,mamicode.com
首页 > 其他好文 > 详细

软件开发的目录规范

时间:2020-03-29 14:17:33      阅读:89      评论:0      收藏:0      [点我收藏+]

标签:settings   项目   维护   rem   编码风格   col   path   操作   部署   

为了提高程序的可读性与可维护性,我们应该为软件设计良好的目录结构,这与规范的编码风格同等重要。软件的目录规范并无硬性标准,只要清晰可读即可,假设你的软件名为foo,笔者推荐目录结构如下

Foo/
|-- core/
|   |-- core.py
|
|-- api/
|   |-- api.py
|
|-- db/
|   |-- db_handle.py
|
|-- lib/
|   |-- common.py
|
|-- conf/
|   |-- settings.py
|
|-- run.py
|-- setup.py
|-- requirements.txt
|-- README

简要解释一下:

? • core/: 存放业务逻辑相关代码

? • api/: 存放接口文件,接口主要用于为业务逻辑提供数据操作。

? • db/: 存放操作数据库相关文件,主要用于与数据库交互

? • lib/: 存放程序中常用的自定义模块

? • conf/: 存放配置文件

? • run.py: 程序的启动文件,一般放在项目的根目录下,因为在运行时会默认将运行文件所在的文件夹作为sys.path的第一个路径,这样就省去了处理环境变量的步骤

? • setup.py: 安装、部署、打包的脚本。

? • requirements.txt: 存放软件依赖的外部Python包列表。

? • README: 项目说明文件。

 

软件开发的目录规范

标签:settings   项目   维护   rem   编码风格   col   path   操作   部署   

原文地址:https://www.cnblogs.com/bk134/p/12592046.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!