2016-10-21 10 views
3

は、私は、次のファイル構造を持っていると言う:ドキュメントをmatlabパッケージに追加するにはどうすればいいですか?

+mypackage/ 
    foo.m 
    bar.m 

私はhelp(mypackage)の出力にヘルプを追加できますか?

Pythonでは、私は__init__.pyにdocstringを追加します。ここに相当するものは何ですか?

+1

参照:[ヘルプサマリーファイルを作成する](https://www.mathworks.com/help/matlab/matlab _prog/create-a-help-summary-contents-m.html) – excaza

+0

助けても、matlabのページはログインリダイレクトループで私を罠に陥り、私のために読み込めません – Eric

+3

ブラウザの設定を調整してください。 MATLABのドキュメンテーションはログインを必要としません。 – excaza

答えて

2

MATLABのtoolbox distribution documentationによると、MATLABのPythonの__init__.py docstringはhelp summary fileになります。上記のフォルダ構造を使用して

、我々は必要な動作を実現するためにcontents.mファイルを追加することができます。

基本的な contents.mファイル考える
+mypackage/ 
    foo.m 
    bar.m 
    contents.m 

% This is contents.m 
% This package contains: 
%  bar - Bar things 
%  foo - Foo things 

私たちは以下のことを実現:

>> help mypackage 
    This is contents.m 
    This package contains: 
     bar - Bar things 
     foo - Foo things 
関連する問題