「Ocaml的docstring」修訂間的差異

於 2024年3月25日 (一) 20:13 的最新修訂

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

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

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

open A
open B
(**
I'm a module
*)

[body of program...]

在函數前輸入(** [docstring內容] *)，如


(**
the function's docstring
intro

*)
let foo x = ...

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

{ul {- 第一條內容}
{- 第二條內容}
{- 第三條內容}}

{[
第一行內容
第二行內容
]}

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

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

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

於 2023年8月27日 (日) 01:37 的修訂（檢視原始碼） Tankianting（討論 \| 貢獻）（建立內容為「{{nav\|程式語言、邏輯學}} 寫一個軟體，通常需要有Document String 嵌入程式碼，雖然形式類似註解，但是可以產生比較好閱讀…」的新頁面）		於 2024年3月25日 (一) 20:13 的最新修訂（檢視原始碼） Tankianting（討論 \| 貢獻）
行 1：		行 1：
	{{nav\|程式語言、邏輯學}}		{{nav\|程式語言、邏輯學\|OCaml筆記}}

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