博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
软件目录结构规范
阅读量:5054 次
发布时间:2019-06-12

本文共 1030 字,大约阅读时间需要 3 分钟。


 

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包含的东西太多了,初学者就写一个安装脚本即可

 

转载于:https://www.cnblogs.com/wazy/p/8023958.html

你可能感兴趣的文章
jdk从1.8降到jdk1.7失败
查看>>
一些关于IO流的问题
查看>>
mongo备份操作
查看>>
8 -- 深入使用Spring -- 3...1 Resource实现类InputStreamResource、ByteArrayResource
查看>>
硬件笔记之Thinkpad T470P更换2K屏幕
查看>>
一个关于vue+mysql+express的全栈项目(六)------ 聊天模型的设计
查看>>
【知识库】-数据库_MySQL 的七种 join
查看>>
.net 写文件上传下载webservice
查看>>
noSQL数据库相关软件介绍(大数据存储时候,必须使用)
查看>>
iOS开发——缩放图片
查看>>
HTTP之URL的快捷方式
查看>>
满世界都是图论
查看>>
配置链路聚合中极小错误——失之毫厘谬以千里
查看>>
代码整洁
查看>>
蓝桥杯-分小组-java
查看>>
Java基础--面向对象编程1(类与对象)
查看>>
Android Toast
查看>>
iOS开发UI篇—Quartz2D使用(绘制基本图形)
查看>>
docker固定IP地址重启不变
查看>>
桌面图标修复||桌面图标不正常
查看>>