首页 > 其他 > 详细

软件开发的目录规范

时间:2021-04-01 23:34:47      阅读:26      评论:0      收藏:0      [点我收藏+]

软件开发的目录规范

1.区分py文件的两种用途

1.__name__ = __main__的文件

此类文件一般是执行文件,只有在本页运行才能执行其中的代码。

 

其他的都是模块文件,__name__就是其本身。

 

2.软件开发的目录规范

core:存放业务逻辑相关的代码,一般是用户视图层

api:存放接口文件,接口主要用于为接口逻辑提供数据操作

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

conf:存放配置文件

run.py:执行文件

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

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

README: 项目说明文件

除此之外,有一些方案给出了更加多的内容,比如LICENSE.txt,ChangeLog.txt文件等,主要是在项目需要开源时才会用到,请读者自行查阅。

关于README的内容,这个应该是每个项目都应该有的一个文件,目的是能简要描述该项目的信息,让读者快速了解这个项目。它需要说明以下几个事项:

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

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

3、简要的使用说明;

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

5、常见问题说明。

 

软件开发的目录规范

原文:https://www.cnblogs.com/yuxinplus/p/14607697.html

(0)
(0)
   
举报
评论 一句话评论(0
关于我们 - 联系我们 - 留言反馈 - 联系我们:wmxa8@hotmail.com
© 2014 bubuko.com 版权所有
打开技术之扣,分享程序人生!