Auch dieser Behelf ersetzt aus meiner Sicht immer noch nicht die dringend benötigte API-Dokumentation. Denn diese beinhaltet ja die für den Anwender unabdingbare Informationen wie: * Angedachte Intention bei Funktionen. * Besonderheiten beim Einsatz (Annahmen über bestimmte Zustände, wo nicht,...) * Datenrichtung der Parameter. * Bedeutung der Parameter. Worauf bezieht sich z.B. eine match-Zeichenkette bzw. wo ist ihr Gegenstück? * Strukturkomponenten: genaue Bedeutung. * Erläuterung der Rückgabewerte.
Ich habe den Artikel jetzt 2 mal gelesen und verstehe immer noch nicht was dieses Programm macht außer Indizes über ein Git-Repo zu bringen. Was macht dieses Programm und wofür kann man es gebrauchen?
Das Programm erlaubt die komfortable Suche nach Bezeichnern in Programmen (z.B. verwendeten Funktionen) durch einfaches Anklicken in einer Quelltext-Ansicht. Das ist unter anderem hilfreich, wenn man den Programmfluss über mehrere mehrere Funktionsaufrufe hinweg nachvollziehen möchte, die ggf. in verschiedenen Dateien definiert sind.
Auch dieser Behelf ersetzt aus meiner Sicht immer noch nicht die dringend benötigte API-Dokumentation. Denn diese beinhaltet ja die für den Anwender unabdingbare Informationen wie:
* Angedachte Intention bei Funktionen.
* Besonderheiten beim Einsatz (Annahmen über bestimmte Zustände, wo nicht,...)
* Datenrichtung der Parameter.
* Bedeutung der Parameter. Worauf bezieht sich z.B. eine match-Zeichenkette bzw. wo ist ihr Gegenstück?
* Strukturkomponenten: genaue Bedeutung.
* Erläuterung der Rückgabewerte.
Ich habe den Artikel jetzt 2 mal gelesen und verstehe immer noch nicht was dieses Programm macht außer Indizes über ein Git-Repo zu bringen. Was macht dieses Programm und wofür kann man es gebrauchen?
Das Programm erlaubt die komfortable Suche nach Bezeichnern in Programmen (z.B. verwendeten Funktionen) durch einfaches Anklicken in einer Quelltext-Ansicht. Das ist unter anderem hilfreich, wenn man den Programmfluss über mehrere mehrere Funktionsaufrufe hinweg nachvollziehen möchte, die ggf. in verschiedenen Dateien definiert sind.
Mein nächstes Programm nenne ich „Python“ – geschrieben natürlich in „Elixir“.
Päng!! Genau das gleiche gedacht...was für ne dämliche namenswahl.