1.10 组织好代码文件,要有“用户思维”

本文内容是极客时间课程——代码精进之路中代码规范篇的学习笔记。

 

1.软件是干什么的
通过README文件
 
2.软件可以哪来用吗
版权描述一般放在每一个源文件的头部
 
3.软件是怎么实现的
源代码在根目录的src目录下
 
4.软件该怎么测试
单元测试放在根目录的test目录下
 
5.软件该怎么使用
文档放在根目录下的doc或docs的目录下
 
6.文件的组织原则
(1)文件的组织要一目了然,越直观,约有效率;
(2)可维护性要优先考虑。这要求文件组织要层次分明,合理区隔、照应、使用不同的空间。
 
posted @ 2021-01-16 15:24  徐浩进  阅读(66)  评论(0编辑  收藏  举报