Wie füge ich "Hilfe" -Text zu einer Mex-Funktion hinzu?

8

Ich schreibe eine Matlab-Mex-Datei. Allerdings scheinen mex-Dateien eine ernsthafte Einschränkung zu haben: help mexfilename wird nicht dazu führen, dass ein Hilfetext erscheint.

Ich könnte das umgehen, indem ich eine m-Datei schreibe, die letztendlich die mex-Datei aufruft, aber Hilfe enthält, aber es muss einen besseren Weg geben.

Auf der anderen Seite könnte ich auf diese Weise alle Fehler in der m-Datei überprüfen, wo es viel bequemer ist ...

    
bastibe 10.02.2009, 13:57
quelle

2 Antworten

10

Ich glaube, PierreBdR hat recht; Sie würden eine m-file-Version Ihrer Funktion nur mit dem Header-Aufruf und dem Kommentarblock erstellen, aber keine Nachricht.

Es ist vielleicht keine schlechte Idee, die Fehlerüberprüfung für die Eingaben in der m-Datei vorzunehmen, dann muss die m-Datei die mex-Datei aufrufen (Sie müssen ihnen jedoch möglicherweise andere Namen geben). Es kann einfacher sein, Variablen in MATLAB zu überprüfen (z. B. mit Einbauten wie nargchk ) und lege sie in ein Standardformat, das die Eingaben in die mex-Funktion immer haben sollen. Viele der Image Processing Toolbox-Funktionen, die ich angeschaut habe, scheinen dies zu tun (Formatieren und Überprüfen von Daten in der m-Datei, dann Ausführen der teuren Berechnungen in einer mex-Datei).

    
gnovice 10.02.2009, 15:28
quelle
5

Sie müssen eine m-Datei (name.m) mit demselben Namen wie Ihre mex-Datei (name.c) erstellen. Dann setzen Sie die Funktionsdeklaration und den Hilfetext, aber keinen Funktionskörper. Beispiel:

%Vor%     
PierreBdR 10.02.2009 14:50
quelle

Tags und Links