zoukankan      html  css  js  c++  java
  • 软件目录结构规范


    1.什么是软件目录结构?


      "项目目录" = "个人风格" ,即可代表个人,也可为项目增加可读让不熟悉这个项目的"接班人",可以用最快的速度看懂项目代码.

    规范化代码可以更好的控制结构,不会产生"写着写着不知道干嘛了也不知道前面自己干了些什么"的情况,而不是仅仅让代码可以工作就OK的。

    下面给大家举个例子

    | Code

    |--------| bin

    |--------|--------| code

    |--------| code

    |--------|--------| main.py

    |--------| conf

    |--------|--------| conf.py

    |--------| log

    |--------|--------| error.log

    |--------|--------| info.log

    |--------| data

    |--------|--------| data

    |--------| setup

    |--------|--------| setup.py

    |--------| README

    • 1.bin下放可执行文件,用来启动服务的
    • 2.code下放主文件,所有源代码,也就是主目录,可以加个测试目录test
    • 3.conf下放配置文件
    • 4.log下放日志文件,用于排错
    • 5.data下放数据,用于储存数据文件
    • 6.setup下有一个setup.py,安装、部署、打包的脚本。
    • 7.README

    README

      这里重点说一下README:这个每个项目都必须要有,而且必须包括以下内容

    • 1.软件定位,软件的基本功能
    • 2.安装环境,启动方法
    • 使用说明(简写)
    • 代码结构,基本原理(开发者人员观看)
    • 常见问题

    当然README不可能一次性全部写完,可以在开发的过程中不断完善,最后将信息补全

    setup

      setup是用于安装,打包,部署环境。python有一个打包工具setuptools是专门用来干这个的。

      平常部署时,需要安装很多东西,例如依赖包,环境,甚至是一些配置,过程繁琐且时间过长,这时候完全可以去写一个setup.py自动化解决,也不需要担心遗漏了某一个东西导致程序无法启动,当然也是只能减少出错的概率,并不能保证百分百不出错

      当然这样的话,setup包含的东西太多了,初学者就写一个安装脚本即可

  • 相关阅读:
    CGAffineTransform的使用大概:
    CYLTabBarController的简单使用
    Masonry详解
    Swift学习 (四)
    《Advanced Bash-scripting Guide》学习(二):测试脚本调用的参数是否正确
    《Advanced Bash-scripting Guide》学习(一):对一个增强和广义的删除logfile的脚本的理解
    [JSOI2007]字符加密Cipher
    codevs 3160 最长公共子串
    codevs 1500 后缀排序
    浅谈后缀数组
  • 原文地址:https://www.cnblogs.com/wazy/p/8023958.html
Copyright © 2011-2022 走看看