看到一个笑话:
程序员最讨厌写文档,比这个还讨厌的事情就是,别人居然不写文档!
程序员不写文档,可能性主要有两条:
第一,不屑于写文档,认为代码胜过文档,代码代表一切!
第二,写不出文档,程序没有好的设计,无法写出清晰的说明设计思想的文档。
我的经验:
一、体现设计思想的文档必不可少,尤其是一些新颖的设计,如果没有文档,代码写的再好,也不便于后续的阅读及理解。
二、文档写的清晰,代码也不会太差。
三、文档不贪多、不贪大、不贪全,但必须和代码保持同步。
看到一个笑话:
程序员最讨厌写文档,比这个还讨厌的事情就是,别人居然不写文档!
程序员不写文档,可能性主要有两条:
第一,不屑于写文档,认为代码胜过文档,代码代表一切!
第二,写不出文档,程序没有好的设计,无法写出清晰的说明设计思想的文档。
我的经验:
一、体现设计思想的文档必不可少,尤其是一些新颖的设计,如果没有文档,代码写的再好,也不便于后续的阅读及理解。
二、文档写的清晰,代码也不会太差。
三、文档不贪多、不贪大、不贪全,但必须和代码保持同步。