当前位置: 技术问答>java相关
讲讲写注释和技术文档的重要性吧（内同，期待高见！）
来源: 互联网 发布时间：2015-01-22
本文导语: | 当写软件的人走了后，老板要你接他的手，而他没有留下文档，你可以想象得到。 | 文档和注释也是代码的一部分。纯代码是给计算机看的，文档和注释是给人看的。计算机不会自动修改功能，...
|
当写软件的人走了后，老板要你接他的手，而他没有留下文档，你可以想象得到。
|
文档和注释也是代码的一部分。纯代码是给计算机看的，文档和注释是给人看的。计算机不会自动修改功能，如果要修改，只能人来修改。如果没有注释和文档，从何修改？
|
1）主要是一个项目大多十几个人做，而维护的只有几个人。
几个人要在短时间内看懂全部的程序。没有良好的注释根本看不懂。
2）就算自己做的程序，过了一段时间，若是程序量比较大，只怕自己都很难懂。
3）写技术文档也是技术成长的必然道路。自己可以对作项目中学到的东西作系统的整理。
几个人要在短时间内看懂全部的程序。没有良好的注释根本看不懂。
2）就算自己做的程序，过了一段时间，若是程序量比较大，只怕自己都很难懂。
3）写技术文档也是技术成长的必然道路。自己可以对作项目中学到的东西作系统的整理。
|
我们这个行业人员流动率太高，所以不可能全都是一个人或一个开发组贯穿整个软件的生命周期。
当软件需要维护或做了一半让你来做时，没有这些你会浪费大量的时间及精力。所以为了别人也为了自己（难保过个三四年你会忘掉自己当初写的东东）我们都应该写注释与技术文档。
当软件需要维护或做了一半让你来做时，没有这些你会浪费大量的时间及精力。所以为了别人也为了自己（难保过个三四年你会忘掉自己当初写的东东）我们都应该写注释与技术文档。
您可能感兴趣的文章:
本站(WWW.)旨在分享和传播互联网科技相关的资讯和技术，将尽最大努力为读者提供更好的信息聚合和浏览方式。
本站(WWW.)站内文章除注明原创外，均为转载、整理或搜集自网络。欢迎任何形式的转载，转载请注明出处。
本站(WWW.)站内文章除注明原创外，均为转载、整理或搜集自网络。欢迎任何形式的转载，转载请注明出处。