在一个项目中会有一个项目小组进行合作,如果大家都是自始至终的负责这个项目的话,那可能管理起来就很方便,但是每个公司难免会有人事调动,那么新来的就对项目中的东西一头雾水,举个例子,这个项目的代码中有N个文件夹,每个文件夹可能有N个类,每个类有N个方法,新来的人怎么会明白他们是干什么的,这个是个让人抓狂的事情。。。
很多人就想到了注释,对注释是一个很传统的方法也是一个很有效的方法,但是每个文件夹的作用,每个JSP页面的作用怎么能知道呢?很多人会想到给他们取一个简单明了的名字,但是再简单明了的名字新人看了也不见得都能看明白,不是吗?
所以我想到一个非常笨的方法:
1.每个文件夹都有一个Readme文件,里面详细说明该文件夹下每个文件夹/文件的作用,每增加或减少文件都要在Readme文件中做添加或删除
2.每个类要有注释,每个方法要有注释,每个变量要有注释
3.项目进行中,如果有任何需求方面的改动都要落实成文档,否则都要改回来改回去,陷入无尽的轮回