0%
这是一片思考的空间 -- arthinking
Spring 重构&代码整洁之道 软件设计 JVM 并发编程 数据结构与算法 分布式 存储 网络 微服务 设计模式
Java技术栈 - 涉及Java技术体系

为什么API文档如此重要

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

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

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

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

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

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

欢迎关注我的其它发布渠道

订阅IT宅
内功修炼
Java技术栈
Java架构杂谈是IT宅精品文章公众号,欢迎订阅:
📄 网络基础知识:两万字长文50+张趣图带你领悟网络编程的内功心法 📄 HTTP发展史:三万长文50+趣图带你领悟web编程的内功心法 📄 HTTP/1.1:可扩展,可靠性,请求应答,无状态,明文传输 📄 HTTP/1.1报文详解:Method,URI,URL,消息头,消息体,状态行 📄 HTTP常用请求头大揭秘 📄 HTTPS:网络安全攻坚战 📄 HTTP/2:网络安全传输的快车道 📄 HTTP/3:让传输效率再一次起飞 📄 高性能网络编程:图解Socket核心内幕以及五大IO模型 📄 高性能网络编程:三分钟短文快速了解信号驱动式IO 📄 高性能网络编程:彻底弄懂IO复用 - IO处理杀手锏,带您深入了解select,poll,epoll 📄 高性能网络编程:异步IO:新时代的IO处理利器 📄 高性能网络编程:网络编程范式 - 高性能服务器就这么回事 📄 高性能网络编程:性能追击 - 万字长文30+图揭秘8大主流服务器程序线程模型
📄 Java内存模型:如果有人给你撕逼Java内存模型,就把这些问题甩给他 📄 一文带你彻底理解同步和锁的本质(干货) 📄 AQS与并发包中锁的通用实现 📄 ReentrantLock介绍与使用 📄 ReentrantReadWriteLock介绍与使用 📄 ReentrantLock的Condition原理解析 📄 如何优雅的中断线程 📄 如何优雅的挂起线程 📄 图解几个好玩的并发辅助工具类 📄 图解BlockingQueue阻塞队列
📄 消息队列那么多,为什么建议深入了解下RabbitMQ? 📄 高并发异步解耦利器:RocketMQ究竟强在哪里? 📄 Kafka必知必会18问:30+图带您看透Kafka
📄 洞悉MySQL底层架构:游走在缓冲与磁盘之间 📄 SQL运行内幕:从执行原理看调优的本质 📄 洞悉Redis技术内幕:缓存,数据结构,并发,集群与算法