有沒有寫matlab文件的開始註釋的標準？

是否有傳統的格式來編寫matlab文件的開始描述？有沒有寫matlab文件的開始註釋的標準？

如包括作者（S），版本號，最新修訂上，等

當我搜索了這一切，我覺得是comments themselves或commenting the help text for functions信息。

編輯：
爲了澄清，我想知道是否有一個地方可以放置整個模擬的作者的詳細信息，例如？ I.e：不是函數描述/幫助文本的文本（這也非常有用，並且非常感謝您提供關於此的詳細信息）。

在mathworks上，我找到了關於Contents.m file的信息。使用時，它提供程序文件的摘要和版本號。有沒有人使用這個文件來包含額外的細節，例如作者身份，位置等？

我基本上只是想着其他公約，如在Java中（我的意思並不是要比較兩個，但只是添加澄清什麼，我一直在尋找）：

/** 
* The Foo program displays Hello World! 
* 
* @author J Smith << A place to put these details? 
* @version 1.0 
* @since 2016-08-23 
*/ 
public class Foo { 
    public static void main(String[] args) { 
     System.out.println("Hello World!"); 
    } 
}

來源

2016-08-15 oppnahar

沒有，不是「官方」/「通用」標準。你可以選擇任何你想要的會議，或者推出自己的會議。一旦你決定如何讓你的評論看起來像，一致並堅持它是一個好主意。

通常，至少對於大多數內置函數，您會發現1.簡短說明，其次是2.使用語法，3.更全面的說明和4.相關功能。

來源

2016-08-15 21:14:45 dangom

*是*官方標準，matlab甚至提供了一種工具來檢測不一致性，並幫助您編寫符合Mathworks標準的適當幫助標題。但顯然它不強制執行這種風格。 –

我不會去幫助指導一個標準（考慮OP的要求），但謝謝指出。 – dangom

不錯，是的。我想，這是一個定義問題。我的感覺是，這是一個「標準」，因爲某些功能依賴於它的遵循（例如'lookfor'，'help'，'see also'，鏈接，版權和版本串等等都需要特定的格式才能運行）而不是「準則」，這只是一個美學問題（例如[倍頻程編碼準則]（https://www.gnu.org/software/octave/doc/v4.0.0/Octave-Sources-_0028m_002dfiles_0029）。 HTML＃倍頻源-_0028m_002dfiles_0029））。 –

要看到一個例子，MATLAB運行此命令：

edit fft

順便說一句，作爲@DanielG說沒有官方/通用標準。

來源

2016-08-15 21:16:05 NKN

'fit'示例需要曲線擬合工具箱。更好地使用核心函數'fft'。 – dangom

正確！ '編輯fit'需要曲線擬合工具箱。 – NKN

Matlab的並不強制，但它確實有之一，這裏提供了一個基本的例子：http://uk.mathworks.com/help/matlab/matlab_prog/add-help-for-your-program.html

一個有用的命令，以幫助您檢查您是否已經添加適當的文件是helprpt。如果您缺少幫助標題，或者您的幫助標題缺少語法等，它會告訴您。 編輯：這已被2016a中的圖形菜單取代;見here。也看看codetools。此外，Octave在octave手冊中定義了something similar，以及coding style in general中的一些有用指南; （我覺得這種風格很整潔，我推薦它）。一般來說，無論是在matlab中還是在倍頻程中，貫穿所有m文件都會保持一致的風格;如果你從發行版中打開任何m文件並且模仿這個風格，那麼你就會發現它是正確的。

來源

2016-08-15 22:01:53

雖然沒有爲內容沒有嚴格的標準你的函數開始評論（即"Help text"）的，還有你應該知道他們的格式決定MATLAB將如何使用或展示他們一些具體的東西。讓我們先從這個樣本：

function c = addme(a,b) 
% ADDME Add two values together. <---- H1 line 
% C = ADDME(A) adds A to itself. 
% C = ADDME(A,B) adds A and B together. 
% 
% See also SUM, PLUS. 

% Some other comment... 

switch nargin 
    case 2 
    c = a + b; 
    case 1 
    c = a + a; 
    otherwise 
    c = 0; 
end

1）H1行：這是第一個註釋行，這就是將當前文件夾瀏覽器或lookfor命令得到顯示。當使用lookfor命令時，這是默認搜索的第一個註釋塊的唯一部分。您必須爲要搜索的整個幫助評論塊添加-all選項。因此，在這裏放置關鍵的描述性詞彙以幫助人們搜索與某些操作相關的功能通常是一個好主意。

2）help命令：使用help命令時，將顯示功能中整個第一個連續的註釋塊。對於上述示例，help addme將顯示所有評論，包括'另請參見...'一行，但不會顯示'其他評論...'一行。

3）超鏈接到其他功能：如果您希望在您的幫助，超文本鏈接到相關的功能，您可在線路% See also添加到您的幫助文本，隨後這些函數的名稱結束。對於上述示例，鍵入help addme將顯示幫助文本，其中包含sum和plus函數的鏈接，並且單擊這些鏈接將依次顯示這些函數的幫助文本。

除了這幾點考慮之外，您需要確定您的幫助文本應該包含哪些內容。我通常在「越多越好」方面犯錯。 :)

來源

2016-08-15 22:19:37 gnovice

很好的信息在這裏！ –

有沒有寫matlab文件的開始註釋的標準？

回答

相關問題