Kokujou Geschrieben 7. März 2018 Melden Share Geschrieben 7. März 2018 Hallo, Sicher kennt ihr das, dass man manchmal bei Mouseover eine Beschreibung der Funktion kriegt und was die Parameter machen. Wie kriegt man sowas im eigenen Code hin? Dasselbe gilt, wenn man gerade z.B. dabei ist einen Parameter einzugeben. Manchmal zeigt VisualStudio mir dann an, was der Parameter bedeutet. Sowas würde ich gerne bei mir einbauen. Link zu diesem Kommentar Auf anderen Seiten teilen More sharing options...
Zer0Cool Geschrieben 7. März 2018 Melden Share Geschrieben 7. März 2018 Ich kenn den Summary:https://docs.microsoft.com/de-de/dotnet/csharp/programming-guide/xmldoc/summary Das mit Parametern könnte hiermit gehen:https://docs.microsoft.com/de-de/dotnet/csharp/programming-guide/xmldoc/param PS: Hat mich auch gerade angespornt mal ein wenig Doku in meinen Code einzubauen ... "cref" scheint mir auch noch recht nützlich, damit kann man Querverweise auf Typen oder Variablen herstellen. Link zu diesem Kommentar Auf anderen Seiten teilen More sharing options...
Kokujou Geschrieben 7. März 2018 Autor Melden Share Geschrieben 7. März 2018 Vielen Dank! Was genau ist cref? das ist genau das was ich brauche :3 Ja gelegetlich brauche ich auch mal etwas Doku, besonders wenn man nach nem halben Jahr wieder in den Code schnuppert^^ Link zu diesem Kommentar Auf anderen Seiten teilen More sharing options...
Zer0Cool Geschrieben 8. März 2018 Melden Share Geschrieben 8. März 2018 Also ich habe jetzt folgende "Tags" als für mich "anwendbar" in meinen Code übernommen: <summary> (Kommentar für eine Klasse oder Methode) <param> (Kommentar für einen Parameter) <return> (Kommentar für einen Rückgabewert) <see cref> (Verlinkung eines Datentyps, einer Klasse oder eines Klassenmembers) <para> (= Textabsatz) Kleines Beispiel zu cref aus meinen aktuellen Klassen: /// <summary> /// Controls and passes values to a UI <see cref="Slider"/>. /// The slider will be connected with the related data of grass render system by the <see cref="SliderField"/>. /// </summary> [RequireComponent(typeof(Slider))] public class SliderController : MonoBehaviour { public string SliderField; private Slider slider; ... ... ... Beispiel <param>: /// <summary> /// Invoked when the value of the <see cref="Slider"/> changes. /// </summary> /// <param name="field">The identifier of the slider field.</param> private void ValueChangeCheck(string field) { ... ... Link zu diesem Kommentar Auf anderen Seiten teilen More sharing options...
Kokujou Geschrieben 8. März 2018 Autor Melden Share Geschrieben 8. März 2018 funktioniert das in jedem Kommentar oder braucht man die //-Teile? /* */ würde sich besser anfühlen^^ Link zu diesem Kommentar Auf anderen Seiten teilen More sharing options...
Tiwaz Geschrieben 8. März 2018 Melden Share Geschrieben 8. März 2018 Das Summary-Kommentar wird durch /// definiert, also durch drei Slashes, nicht wie normale Kommentare mit zwei oder /* Gibts auch in anderen Programmiersprachen, Javadoc Kommentare (also in Java) werden zum Beispiel mit /** definiert Link zu diesem Kommentar Auf anderen Seiten teilen More sharing options...
Kokujou Geschrieben 8. März 2018 Autor Melden Share Geschrieben 8. März 2018 Ach stimmt! XD Tut mir leid ich bin so an // gewöhnt dass ich den 3. direkt übersehen habe. Und gibts dann auch nen Summary-Kommentar der über mehrere Zeilen geht wie in Java mit /** ? Link zu diesem Kommentar Auf anderen Seiten teilen More sharing options...
Zer0Cool Geschrieben 8. März 2018 Melden Share Geschrieben 8. März 2018 Das Kommentar ist fortlaufend (ohne Zeilenumbruch), es sei denn du verwendest <para>. Alles was zwischen den <summary> tags liegt ist das Kommentar: /// <summary> /// Kommentarsatz 1 /// Kommentarsatz 2 /// <para> Kommentarsatz 3 in einer neuen Zeile (Absatz) </para> /// Kommentarsatz 4 /// Kommentarsatz 5 /// </summary> Mhh das <para> macht wohl einen Zeilenumbruch + leere Zeile oben und unten, also etwas zu viel Link zu diesem Kommentar Auf anderen Seiten teilen More sharing options...
Tiwaz Geschrieben 8. März 2018 Melden Share Geschrieben 8. März 2018 Wenn du einen Zeilenumbruch machst generiert dir die IDE automatisch /// (bzw. in Javadoc *) hin. Warum willst du denn /* benutzen? Damit du nicht manuell /// vor jede Zeile schreiben musst? Das macht nämlich wie gesagt Visual Studio von selbst. Oder gehts nur im Ästhetik weil du nicht vor jeder Zeile /// haben willst? Da glaube ich müsstest du dann in den sauren Apfel beißen keine Ahnung, ob es da eine Alternative gibt. Link zu diesem Kommentar Auf anderen Seiten teilen More sharing options...
Kokujou Geschrieben 8. März 2018 Autor Melden Share Geschrieben 8. März 2018 Naja ich wollte es ja nur fragen. Funktionsmäßig ist es ja das gleiche aber ja es ging nur um Faulheit Danke für die schnellen und guten Antworten~ ich würd sagen die Frage ist damit beantwortet Link zu diesem Kommentar Auf anderen Seiten teilen More sharing options...
Recommended Posts
Archiviert
Dieses Thema ist jetzt archiviert und für weitere Antworten gesperrt.