下一個:,上一個:,上層:文件   [目錄][索引]


6.2 文件字串與手冊

有些程式設計系統,例如 Emacs,為每個函式、命令或變數提供文件字串。你可能會想要透過編譯文件字串並在周圍撰寫一些額外文字來撰寫參考手冊——但你絕不能這樣做。這種做法是一個根本性的錯誤。寫得好的文件字串的文字對於手冊來說會完全不適用。

文件字串需要獨立存在——當它出現在螢幕上時,不會有其他文字來介紹或解釋它。同時,它的風格可以相當非正式。

在手冊中描述函式或變數的文字不能獨立存在;它出現在章節或子章節的上下文中。章節開頭的其他文字應解釋一些概念,並且通常應提出一些適用於多個函式或變數的通用要點。本章節中先前對函式和變數的描述也將提供有關該主題的資訊。為了獨立存在而撰寫的描述會重複其中一些資訊;這種冗餘看起來很糟糕。同時,在文件字串中可以接受的非正式性在手冊中是完全不能接受的。

在撰寫好的手冊時,使用文件字串的唯一好方法是將它們用作撰寫良好文字的資訊來源。