当前位置: 首页 > 知识库问答 >
问题:

前端 - 我们在开references API文档的时候,文档描述很简单,我们怎么才能学习这些API?

崔绍辉
2024-04-05

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

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

1、refenreces 怎么翻译呢?
翻译为:参考文献吗?

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

共有1个答案

周朗
2024-04-05

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

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

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

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

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

 类似资料:
  • 有什么方法可以简化这段代码吗?我正好有一个白色的一块,想要得到它的位置 代码: 瓦片类: 件类:

  • 我们知道API文档可以看到一个项目的所有可以使用的API,(类和它提供的属性方法) https://microsoft.github.io/monaco-editor/docs.html 但是我们知道了这个API Document,看到了有这些类,但是我们 如何验证和使用这些API呢? 比如在开发中想要使用某个类如何进行使用呢?

  • 我们终于要开始了! 但首先,让我们告诉你什么是 Python。Python 是一种非常流行的编程语言,可以用来创建网站、 游戏、 科学软件、 图形和很多很多其他的东西。 Python 起源于 1980 年代后期,该语言的重要目标是源代码的人类可读性 (而不是机器!)。 这就是为什么它看起来比其他编程语言简单得多。 这使得它易于学习,但不要担心,Python 也是真的很强大 ! Python 的安装

  • 我需要将一个JSON文件推进到一个Kafka主题中,在presto中连接该主题,并将JSON数据结构化到一个可查询的表中。

  • 我们可以在从 BLOB 存储下载文件时在微软办公文档中添加水印文本吗? 我的分析正在使用 AIP - Azure 信息保护进行。

  • 只是些反射型 XSS,单单发出来没有什么意义。 只是些反射型 XSS,腾讯怎么修都修不完。 只是些反射型 XSS,我想让它变得更有价值。 只是些反射型 XSS,我拿他们做成了教程。