This is documentation for Mathematica 4, which was
based on an earlier version of the Wolfram Language.
View current documentation (Version 11.1)

 Documentation /  Mathematica /  Das Mathematica Buch /  Die Prinzipien von Mathematica /  Textförmige Eingabe und Ausgabe /

Internationale MeldungenInhalt

2.8.23 Dokumentations-Konstrukte

Wenn Sie in Mathematica Programme schreiben, gibt es mehrere Wege, Ihren Code zu dokumentieren. Wie immer ist es sicher am besten, klaren Code zu schreiben, und die Namen der von Ihnen definierten Objekte so ausführlich wie möglich zu benennen.

Manchmal möchte man jedoch dem Code etwas „kommentierenden Text" hinzufügen, damit dieser besser zu verstehen ist. Derartigen Text können Sie an jeder Stelle Ihres Codes hinzufügen, einfach durch Einschluß mit paarweisen (* und *). Beachten Sie: In Mathematica können durch (* und *) eingeschlossene „Kommentare" beliebig geschachtelt werden.

Kommentare können überall in dem von Ihnen geschriebenen Mathematica-Code eingesetzt werden.

In[1]:= If[a > b, (* dann *) p, (* sonst *) q]

Out[1]=

Kommentare in Mathematica

Es gibt eine Konvention in Mathematica, daß alle Funktionen, die für späteren Gebrauch bestimmt sind, eine genaue „Anwendungs-Meldung" erhalten sollten, die ihre Grundverwendung dokumentiert. Diese Meldung ist als Wert von f::usage definiert und wird nach Eingabe von ?f wieder hervorgeholt.

Anwendungs-Meldungen für Funktionen

Hier ist die Definition einer Funktion f.

In[2]:= f[x_] := x^2

Hier ist eine „Anwendungs-Meldung" für f.

In[3]:= f::usage = "f[x] ergibt das Quadrat von x."

Out[3]=

Dies liefert die Anwendungs-Meldung für f.

In[4]:= ?f

??f liefert die gesamte Information, die Mathematica über f zur Verfügung steht, einschließlich der eigentlichen Definition.

In[5]:= ??f

Wenn Sie eine Funktion f definieren, können Sie normalerweise ihren Wert mit ?f darstellen lassen. Wenn Sie jedoch eine Anwendungs-Meldung für f angeben, wird ?f nur die Anwendungs-Meldung liefern. Nur wenn Sie ??f eingeben, erhalten Sie ausführliche Auskunft über f, einschließlich ihrer eigentlichen Definition.

Wenn Sie für nur eine Funktion mit ? Informationen anfordern, so wird Mathematica die vollständigen Anwendungs-Meldungen für die Funktion ausdrucken. Wenn Sie gleichzeitig Informationen für mehrere Funktionen anfordern, wird Mathematica Ihnen jedoch nur die Namen der Funktionen liefern.

Einige typische Dokumentations-Meldungen

Zusätzlich zu den Anwendungs-Meldungen gibt es einige Meldungen, wie notes und qv, die häufig zur Dokumentation von Funktionen definiert sind.

Wird Mathematica mit einer textorientierten Schnittstelle eingesetzt, dann sind Meldungen und Kommentare die primären Mechanismen zur Dokumentation Ihrer Definitionen. Wird Mathematica mit einer Notebook-Schnittstelle benutzt, so können in den Textzellen eines Notebook-Dokumentes weit ausführlichere Dokumentationen eingegeben werden.

Internationale MeldungenInhalt