- 论坛徽章:
- 0
|
中午有点时间,我来纠正一下你对oo/java的错误理解,看看究竟是别人“变异”了,还是你“变异”了,免费的,不收钱
1.写java代码,的确靠javadoc来生成api文档,但面向对象语言本身并没有任何规定或建议必须按照javadoc的格式写注释。javadoc只是文档生成器的一种,其他文档生成器,不止能从java代码注释中生成文档,也能从C,php,perl等等函数式语言,脚本语言中生成文档,这可就和纯OO没什么关系了
你说“OO的重要目标之一是替代文档”
正确的表述应该是:“文档生成器的重要目标是替代单独编写api文档”
2.文档分很多种类型 ,对于程序员来说,除了api文档外,架构/设计文档也非常重要,尤其在大中型项目中。而文档生成器只能生成api文档。
3.文档的目的是沟通,没文档,那就只能用嘴了。当然,可以通过完整阅读源代码来理解作者的思想(代码即文档?),但,我们做的毕竟是工程,不是理论研究,得考虑时间/人力成本(仅一个设计/架构图,就能节约大量看代码时间,这取决于人类的认知方式,图形化的东西比线性阅读更容易和更快的理解)
我这说是有关文档的,至于其他的,比如什么代码是否好读等等,因为缺乏限制条件,所以属无意义命题 |
|