为什么API文档如此重要

代码中的注释转换为文档,封装好的API,加上全面的注释,就给人很好用的感觉。

在注释不够具体的情况下,则只能查看源代码了。所以,在编写一个类库时,为了方便大家的学习和使用,提供的API文档应该尽量的具体而全面,这样也降低了阅读源代码的难度。

另外有些类库的源代码写的很优美,阅读它是为了学习里面的编程风格和变成习惯或者思想。

所以学习一个API的方法是:看入门文档或API写Demo,看不懂,找源代码跟踪。所以阅读源代码的前提是熟练使用类库,并对API文档(注释)有了很好的认识。所以,高手不是一蹴而就的,需要扎实的积累,和不但循序渐进的探索。

学习Java第三方类库时的准备工作,关联JDK帮助文档,引入源代码,另外手头备好API文档,有必要的话再下载整个类库的源代码。

其他的编程语言也可以按照类似的方法,比如越来越流行的Javascript,为其找到更好的IDE,自动文档提示,自动代码提示等功能(貌似还没找到这样的比较好的)。

arthinking wechat
欢迎关注itzhai公众号