文件名称：ocaml-documentation-guideline:社区驱动的指南，为OCaml库编写良好的文档
文件大小：9KB
文件格式：ZIP
更新时间：2024-05-31 07:43:13
OCaml文档指南 本文档旨在成为社区主导的一站式参考，介绍如何为OCaml库编写良好的文档。 文档状态：已弃用，但仍然有效-该指南已因此请直接在您的文稿。 目录 记录所有签名 将文档注释放在签名元素之后 编写用法示例 正确弃用文件 有有意义的自述文件 2.生成文档 奥卡姆多克 奥多克 沙丘（Jbuilder） 奥迪格 托普克 3.使文档在线 最后的话 变更日志 背景 当我们要发布供公众使用的库时，必须有文档。 实际上，这可能是潜在用户是否最终选择在其项目中使用该库的唯一决定因素。 举一个小例子，在一个未公开文档的系统中，每个用户都失去了理解系统的时间（丢失的时间为O（n） ）。 另一方面，在一个文档齐全的系统中，一个人“浪费”了时间记录该系统，但是它为所有其他用户节省了时间（丢失的时间为O（1））。 这是一笔相当不错的投资。 但是，什么才是好的文档？ “足够好”有多好？ 这些问
【文件预览】：
ocaml-documentation-guideline-master
----README.md(23KB)
----.gitignore(0B)