Beispiel Sourcecode

In diesem Abschnitt wird ein Beispiel wie gut dokumentierter Sourcecode aussieht gegeben. Beachten Sie bitte, dass keine Tags und unlesbare Zeichen notwendig sind, damit Doc-O-Matic Kommentare versteht.

Nehmen Sie an Sie haben eine Klasse StringList und Sie wollen dessen Funktion Find dokumentieren. Sie haben beschlossen, das Symbol bei der Implementierung zu beschreiben. Sie wollen einen See Also (Verwandte Themen) Abschnitt, der Hyperlinks zu den verwandten Funktionen IndexOf und Sort und dem Property Sorted erstellt. Überdies wollen Sie detaillierte Beschreibungen für jeden Parameter und Rückgabewert. Überdies sollte eine kurze Beschreibung auf der Themenseite aufscheinen, die den Leser mit dem Zweck der Funktion vertraut macht.

//  Summary:
//      Locates a string in the string list.
//  Arguments:
//      S -     The string to be located.
//      Index - The index of S is returned through this parameter if it
//              was found. It is not guaranteed that Index is not
//              modified, even if the string isn't found.
//  Return Value:
//      TRUE if the string could be found in the string list,
//      FALSE otherwise.
//  Description:
//      Use the find function to locate a string S in the string list.
//      Only use this function if the string list is sorted, to locate
//      a string in a non-sorted string list use IndexOf.
//  See Also:
//      IndexOf, Sort, Sorted
bool StringList::Find(const char *S, int &Index)
{
    [...]
}

function StringList.Find(const S: string; var Index: Integer): Boolean;
begin
    [...]
end;

Siehe auch

Abschnitte Parameter, Rückgabewerte und Members, Abschnitte Siehe auch und benannte Abschnitte, Überblicke

Verwandte Einstellungen

Abschnitte, Anzeigen der Abschnitte, Abschnittsformatierung