代码之家 › 专栏 › 技术社区 › Daniel MoÅ¡mondor

大大小小的API/SDK文档[关闭]

sdk documentation api c#

Daniel MoÅ¡mondor · 技术社区 · 15 年前

有类似的问题 here 但我想通过这次我会得到一些结果并提供附加值。

作为一个SDK开发人员/提供者,我猜应该在文档中编写什么,以及SDK的文档应该是什么样子。脑海中不可避免的部分是:

在你的回答中,请尽量提供至少3个链接,从你的角度来看,这是一个“很棒”的文档,并提供一些关于原因的信息。

如果你想特定于语言,我的目标是c#开发人员,而我的SDK由一组小类组成——因此应答中的文档应该类似。MSDN,DevExpress,Ogre-只是一个我不想被当作例子的例子,因为他们有很多人的日子,但仍然是伟大的。

谢谢

2 回复 | 直到 9 年前

jcomeau_ictx 15 年前

以Java和生物特征为例,使用javadoc构建的标准API文档,如Griaule的at http://www.griaulebiometrics.com/javadoc/FingerprintSDKJava/com/griaule/grfingerjava/GrFingerJava.html ,具有开发人员所需的所有信息;而DigitalPersona有一个PDF文件,其中包含高度编辑的API描述,没有Java开发人员期望的从方法到类到字段的链接。

更具体地说,在你提出的问题答案中,全班的参考资料是最重要的。在那之后,一个示例应用程序使用了大部分的API,包括源代码。