我们在开references API文档的时候，文档描述很简单，我们怎么才能学习这些API？

Question

在阅读开发文档的时候：
Obsidian TS Api

有2个问题想要咨询老师们：

1、refenreces 怎么翻译呢？
翻译为：参考文献吗？

2、我们看文档，这个文档描述的非常简单，根本没有说出class App这个类有什么功能也没有说如何使用，我们应该怎么学习 API？

Answer 1

一般良好的文档包含两部分，guide/tutorial 和 references。

guide/tutorial 作用是带读者过一遍基本使用方法，包括安装和核心类使用，定位是使用教程，对初学者友好的。

reference是API参考手册，就是你截图里这样的。主要作用是列举出可用的接口和接口文档，在你想找某个接口的说明时有用，定位是给已经看过 guide/tutorial 熟练使用者参考的。

reference大多是文档工具从注释生成的，质量不一。有的比较好像go官方的文档和python标准库文档，有的质量不太行比如很多c++库的doxygen文档。

不熟悉的领域入门一般是跟着guide/tutorial走一遍，评估下接口质量和相关编程规范约定，找到真正开始干活的抓手。有了抓手后实际开发中再看reference作为补充，因为guide/tutorial一般不会把每个接口都讲一遍，通常只会讲解下核心类和业务的关键路径。