zoukankan      html  css  js  c++  java
  • 软件开发目录规范

    软件开发目录规范

    功能目的

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

    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://pip.readthedocs.io/en/1.1/requirements.html

  • 相关阅读:
    版本回退
    时光机穿梭
    创建版本库
    安装Git
    Git简介
    Nexus私服安装
    eclipse中创建MAVEN-web项目
    AsyncTask的使用
    在子线程中更新UI,只能使用Handler
    使用VideoView播放视频
  • 原文地址:https://www.cnblogs.com/a736659557/p/11894001.html
Copyright © 2011-2022 走看看