documentation - 我需要在我的文档中介绍什么？

Question

我正在为我编写的一个小型 ActionScript 3 库编写自己的文档。

我试图尽可能地接近 Adob​​e Livedocs 的布局和内容，同时稍微清理一下。

我想我已经涵盖了人们在阅读我的文档时想知道的所有内容，但是在开始添加我创建的所有类之前，我不想错过任何重要的内容等。

有什么你希望一些文件有的吗？大多数文档中是否有您认为不必要的内容？

这是我到目前为止所得到的：https ://projectavian.com/docs/zephyr/#/entity

我试图涵盖的一些事情是：

1. 轻松直接链接到文档部分。即/#/class.propertyOrMethod如上。
2. 页面顶部的简洁表格简要列出了类中存在的每个属性、方法、常量或任何其他相关的主要内容。
3. 与每个属性或方法相关的清晰分隔的信息块，可以通过步骤 1 中的 URL 直接导航到。单击页面顶部表格中的相关文本也将链接到此处。
4. 方法参数的布局整洁，每个参数都有简明的解释。

Answer 1

我真的很喜欢文档的设计。当我第一次做某事时，我喜欢参考其他相关的工作，以确保我涵盖了所有相同的基础。也就是说，我认为你已经涵盖了他们。

我知道的一些有据可查的 AS 类：

TweenMax @ http://www.greensock.com/as/docs/tween/com/greensock/TweenMax.html BulkLoader @ http://media.stimuli.com.br/projects/bulk-loader/docs/ CASA Lib @ http://as3.casalib.org/docs/

您可以浏览它们以获得对高度精炼的 Action Script 类文档的灵感/见解。每一个都经历了多个版本的发布并经受住了时间的考验。