Klicken Sie hier um zu sehen, was Doc-O-Matic aus dem Quellcode generiert.
Doc-O-Matic versteht wie Entwickler den Quellcode dokumentiert. Der folgende Quellcode Kommentar ist Dank der Fähigkeit von Doc-O-Matic natürlichsprachliche Kommentare zu verstehen, leicht lesbar. Die Zeiten, in denen es nötig war Tags zu verwenden, sind mit Doc-O-Matic vorbei.
Wenn Sie XMLDoc oder JavaDoc bevorzugen, kein Problem! Doc-O-Matic unterstützt beide gleich gut und alle drei Formate sind auch im Editor unterstützt, der Kommentare in den Quellcode zurückschreibt.
Klicken Sie die Reiter um andere Kommentarstile zu sehen. Falls Ihre Browser diese Seite nicht ordentlich darstellt klicken Sie hier für eine statische Version dieser Seite.
// 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
// 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.
// Summary:
// Locates a string in the string list.
bool Stringlist::Find(const char *S, int &Index) { [...] }
Wieso nicht einfach Doc-O-Matic gleich ausprobieren?