工程结构化

  工程结构化

  时间层面,结构化意味着通过编写简介的代码并且正如文件系统中文件和目录的组织一样,代码应该逻辑和依赖清晰,在一个健康的开发周期中,代码风格,api涉及,和自动化是非常关键的,同样对于工程架构,仓库的架构也是关键的一部分。

  那么什么是仓库的结构呢?

  当你在Git上狩猎的时候,你能看到很多优秀的开源项目中都有着十分清晰的仓库结构,文件结构。

  而当你自己在统合自己的代码的时候,别人浏览你的git项目,应该让他们清晰的看到,

    工程名字

    工程描述

    一系列的文件

  结构格式大致归类

  1,readme 内涵项目整体的介绍,同时也是一份使用手册,需要时常进行维护更新,通常为rst或者md格式

  2,LICENSE 阐述项目的许可说明和授权

  3,setup.py 通过setup把核心代码打包发布

  4,sample 存放项目的核心代码

  5,requirements.txt 上篇随笔提到过的保存所有项目依赖库信息的文件

  6,docs 存放依赖库的参考文档

  7,tests 所有的代码测试存放在该目录下

  8,makefile 用于项目的命令管理 (开源项目中使用广泛)

根据项目需求自行调整,添加其他的文件和目录。

原文地址:https://www.cnblogs.com/addicated/p/13152105.html