给代码建个好结构

    本文以一个开源项目为例,介绍如何组织一个层次分明、易于检索的文件结构。

    如下图是该项目的根目录:

    

1.README

    大写字母命名,放在根目录中,回答“软件要用来干什么?”的问题。

2.LICENSE

    大写字母命名,放在根目录中,回答“软件可以拿来用吗?”的问题。

3.src目录

    src目录中存放源代码。其中可以进一步划分多个子目录,便于维护。

4.tests目录

    src目录中存放测试代码。测试的组织要对应功能代码的组织,便于快速查找。如:src/math的测试代码应放在tests/math中。

5.doc目录

    doc目录中存放文档。文档能让用户快速的熟悉软件的使用。

6.3rdparty目录

    3rdparty目录中存放项目的依赖项。

 

 

 

 

 

 

 

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值