2013-03-05 45 views
3

如何使用sphinx,這對於自動記錄python代碼非常適用,以便記錄perl代碼?使用獅身人面像的Perl文檔

+0

爲什麼這個問題是downvoted? (+1)獅身人面像幾乎適用於任何(文件)任務。我對PHP有同樣的問題;)...結果:一般來說,你必須爲獅身人面像創建一個'插件'(想一想它叫做域文件),然後編寫(或使用)創建文件的代碼從您的Perl代碼的域文件的語法.. – hek2mgl 2013-03-05 21:12:34

回答

4

Perl代碼應該記錄在POD之內,這是很自然的方式,並且在這個環境中得到了支持。它簡單而強大。

+0

此外,上傳到CPAN時,它只是工作。 – Horus 2013-03-06 03:17:27

+0

您必須考慮到Perl可能是其他語言所代表的大型系統的一部分。因此,開發和運行該系統的組織可能會對整合文檔感興趣。 Dist :: Zilla可以爲我使用pod2markdown的其他POD文件生成Markdown。對於我們工具鏈中使用的一些工具和產品,這些工具和產品本身不處理POD更容易消耗。 – jonasbn 2017-11-02 10:14:01