檢視 Ocaml的docstring 的原始碼

{{nav|程式語言、邏輯學|OCaml筆記}}

寫一個軟體，通常需要有Document String 嵌入程式碼，雖然形式類似註解，但是可以產生比較好閱讀的 reference。

OCaml 的docstring介紹比較少，所以在這裡介紹

==模組嵌入docstring==
在模組之後各<code>open xxx</code>之後，第一行輸入<code>(** [docstring內容] *)</code>，記得註解的頭要兩個星號**，如：

<pre>
open A
open B
(**
I'm a module
*)

[body of program...]
</pre>

==函數嵌入docstring==
在函數前輸入<code>(** [docstring內容] *)</code>，如

<pre>

(**
the function's docstring
intro

*)
let foo x = ...
</pre>


==Docstring 的格式語法==
Ocaml的格式語法不同於Markdown，比較特殊，以下是舉隅：

*<code>{n 內容}</code>：第n級標題，n是整數
*<code>{b 粗體的文字}</code>：粗體文字
*無序列表如下：
<pre>{ul {- 第一條內容}
{- 第二條內容}
{- 第三條內容}}</pre>
*<code>[]</code>：單行程式碼
*多行程式碼如下：
<pre>{[
第一行內容
第二行內容
]}</pre>

==產出html==
因主要大家看文件多用html格式，以下簡介產生html網頁的方法：

<code>ocamlfind ocamldoc [-package 引用的套件] -html -charset=utf-8 程式碼 -d docs</code>

<code>ocamldoc</code> 是主要的生成程式，<code>-charset=utf-8</code> 要求編碼是utf-8，<code>-d</code> 指定產出的目錄。


==參考資料==
*[https://v2.ocaml.org/manual/ocamldoc.html Chapter 19 The documentation generator (ocamldoc)]

[[category:資訊]]