问题描述

大家怎么看待编程开发文档

才学习文档的书写，感觉好长，好麻烦~不知道经验丰富的大牛们是怎么看待开发文档这个东西的？

解决方案

文档的几个基本原则
（1）说明你要做什么，怎么做是代码说明的事情
（2）接口要有详细的文档
（3）不要把不需要的东西写在文档中，写的越多，有用的东西被看到的概率越低

解决方案二：
1、文档能帮助程序员理清思路
2、文档能帮忙别人快速看懂你的程序
3、文档需要简洁

http://www.iosask.com

解决方案三：
编程文挡有二类，一是别人的心得和技术资料，此类需要吃透和理解。二是自已的编程心得，以类要勤记，最好成体系。最后，做到归类，有索引才能在今后的编程大有帮助。

解决方案四：
文档还是很重要的，特别是对于不熟悉你代码的人来说，有文档就可以很快的熟悉你的代码，进行开发、扩展等。

解决方案五：
文档是很重要的，要尽量完善，要不别人接手时要花很久时间去理解你的代码，这样会很浪费时间

解决方案六：
建议你有可能的话，尽量完善文档，这样可以给自己以后理解自己的程序或者其他人接手你的程序，会带来非常大的方便，如果没有文档，也要尽可能完善自己的代码注释