为什么API文档如此重要
本文由发表于5年前 | 编程分享 | 评论数 2 |  被围观 4,123 views+

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

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

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

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

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

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

除了文章中有特别说明,均为IT宅原创文章,转载请以链接形式注明出处。
本文链接:http://www.itzhai.com/why-the-api-documentation-is-so-important.html
关键字: ,
arthinking Java技术交流群:280755654,入门群:428693174 more
分享到:
 
2013 1/12
文章评论
    2条评论
  1. W3Cshare 2013年01月27日16:36:25  #-49楼 回复 回复

    作者描述很文艺啊

  2. W3Cshare 2013年01月28日08:40:47  #-48楼 回复 回复

    不知道可否加个链接啊,我已加好你的了,一起加油学习啊!

给我留言

有人回复时邮件通知我
编程分享的相关文章
随机文章 本月热门 热评
1 使用Github和Bitbucket托管项目 Git的全局配置和单个项目的配置 2013/1/11
2 Javascript笔记 – Javascript中的闭包 2012/5/31
3 使用JavaMail发送指定网页内容到其他邮箱 2011/10/7
4 J2EE基于MVC的各层的设计原则及其编写注意事项 2012/9/15
5 JBoss服务器的安装 基本配置和使用 2011/11/29
6 Java Web笔记汇总 | IT宅文章归档 AD 2011/11/14 2011/11/14
友情推荐 更多
破博客 文官洗碗安天下,武将打怪定乾坤。多么美好的年代,思之令人泪落。
Mr.5's Life 白天是一名程序员,晚上就是个有抱负的探索者
行知-追寻技术之美 关注大数据,分布式系统
我爱编程 编程成长轨迹
Cynthia's Blog 学习笔记 知识总结 思考感悟
 
欢迎关注我的公众号 IT宅
关于IT宅 文章归档

IT宅中的文章除了标题注明转载或有特别说明的文章,均为IT宅的技术知识总结,学习笔记或随笔。如果喜欢,请使用文章下面提供的分享组件。转载请注明出处并加入文章的原链接。 感谢大家的支持。

联系我们:admin@itzhai.com

Theme by arthinking. Copyright © 2011-2015 IT宅.com 保留所有权利.