二郎電子文檔：功能文檔註釋不輸出

我試圖爬朝二郎最佳實踐的學習曲線顯示;剛剛將eDoc集成到我的工作流程中。二郎電子文檔：功能文檔註釋不輸出

這個工作對我來說：

%%% -------------------------------------------------------------------- 
%%% @author Lloyd R. Prentice 
%%% @copyright 2011 Lloyd R. Prentice 
%%% @doc Yada yada 
%%%  ... 
%%% @end 
%%% --------------------------------------------------------------------

一切都在文檔中顯示爲我所期待。

但這並不：

%% Return a list of reserved item types 
item_types() -> 
     ....

我期待看到在電子文檔輸出的功能和文檔註釋的列表。但是，沒有表演。

我已經沖刷電子文檔的文檔，看了網絡上的例子和教程，但我看不到我在做什麼錯。

任何人都可以幫忙嗎？

非常感謝，

LRP

來源

2011-07-26 Lloyd R. Prentice

不需要額外的空間/線條。您可以簡單地使用頂部的工具欄將部分文字標記爲「代碼」。這將以預格式輸出該部分。爲你固定。 –

如果你叫EDOC正確，根據你的例子，我希望看到你的模塊的外形與功能名稱，但不是每個功能的文件一起。

在每個導出的函數上方，您需要添加一個@spec標籤和/或一個-spec標籤以及一個@doc標籤。你可以看到這些解釋here和here。如果您有（或瞄準）最近二郎（> 14B02？）EDOC會讀-spec信息的版本，否則，你將需要使用@spec。

例如：

%% @spec item_types() -> list() 
%% @doc Return a list of reserved item types. 
item_types() ->

或

-spec item_types() -> list(). 
%% @doc Return a list of reserved item types. 
item_types() ->

注意.在-spec的末尾。

來源

2011-07-26 19:54:34

從documentation：

的標籤必須是一個註釋行的第一件事情，除了領先的 '％' 字符和空格。

難道這是什麼原因呢？

來源

2011-07-26 19:49:42 prusswan

首先，只有導出的函數生成的文檔中出現（除非你通過選項「私人」，以電子文檔，告訴它顯示所有非導出函數以及）。所以如果你沒有這樣的聲明：

-export([item_types/0]).

在你的模塊中，函數將不會顯示。

其次，你必須開始在函數聲明上述評論與@doc，如：

%% @doc Return a list of reserved item types 
    item_types() ->

沒有@ - 標記註釋只是一個評論，是由電子文件忽略。

來源

2011-07-28 16:10:46 RichardC

二郎電子文檔：功能文檔註釋不輸出

回答

相關問題