Eine Art eigene "Creator Dokumentation" erstellen?
Hallo zusammen,
Es gibt ja z.B. bei Game Engines eine Creator Dokumentation, wo man sämtliche Befehle ect. Nachlesen kann.
Kann man sowas in der Art selbst erstellen, was dann privat ist, um bei eigenen Coding Projekten den Überblick über alle Klassen und Funktionen zu haben?
Danke im Vorraus, Bohne47
1 Antwort
Natürlich. In C# kann man das beispielsweise so machen
/// <summary>
/// Dies ist die Beschreibung.
/// </summary>
/// <remarks>
/// Ein paar Hinweise
/// </remarks>
/// <param name="parameter">Eine Beschreibung für diesen parameter.</param>
/// <returns>Eien Beschreibung für den Rückgabewert.</returns>
public int EineMethode(int parameter)
{
// code...
}
Dieses Format kann in C# auf alles mögliche angewandt werden und sobald man irgendwo in der IDE darüber hovert wird die Beschreibung angezeigt.
Was du wahrscheinlich gemeint hast war eine Dokumentation davon auf einer Website wie diese bei Microsoft https://learn.microsoft.com/de-de/dotnet/api/system.io.file?view=net-8.0. Solche Dokumentationen können teilweise damit auch generiert werden.
Bei jeder Sprache ist das Format in dem man Methode, usw. für die IDE verständlich dokumentiert etwas anders. So wird das beispielsweise in JS und TS gemacht:
/**
* Eine funktion
* @param {number} parameter - Ein parameter
* @returns {number} Das Ergebnis
*/
function eineFunktion(parameter) {
// code...
}
lg Suiram1