Avatar billede _et Praktikant
23. juli 2004 - 18:45 Der er 4 kommentarer og
2 løsninger

Tilføje kommentar til egne Metoder og properties

Hvordan laver jeg sådan at der står en kommentar, sammen med typen, i de metoder, jeg selv har lavet?

Jeg vil lave sådan at der står hvad metoden kan/gør, ligesom, når man bruger nogle af MS's metoder
Avatar billede 2c Nybegynder
23. juli 2004 - 20:06 #1
Avatar billede snepnet Nybegynder
23. juli 2004 - 22:09 #2
Det er ikke så kompliceret... Du angiver over kommentarene over de respektive klasser / metoder f.eks. som følger :

Hvis du bruger Visual Studio behøves du ikke gøre andet end at sætte de tre skråstreger /// ind oven over det du vil kommenterer, så sætter IDE-et automatisk de relevante tags ind, og så er det bare at udfylde dem.

    /// <summary>
    ///    En fin lille klasse jeg selv har lavet.
    /// </summary>
    /// <remarks>
    ///    Tjah.... den kan ikke bruges til noget som helst
    /// </remarks>
    public class MinEgenKlasse
    {
        /// <summary>
        ///    Standard konstruktør
        /// </summary>
        ///
        /// <returns>
        ///    void
        /// </returns>
        public MinEgenKlasse()
        {
        }

        /// <summary>
        ///    Metode til at returnere længden af en streng.
        /// </summary>
        /// <param name="parameter" type="string">
        ///    <para>
        ///        Den streng du ønsker længden af.
        ///    </para>
        /// </param>
        /// <returns>
        ///    længden af parameter.
        /// </returns>
        public int MinEgenMetode(string parameter)
        {
            return parameter.Length;
        }
    }
Avatar billede snepnet Nybegynder
23. juli 2004 - 22:14 #3
Der er selvfølgelig en række forskellige tags du kan bruge, og som du kan finde forskellige steder, men.... Der findes et rigtig fint program du kan bruge til at genere documentation (som i Visual Studio og andet).

Programmet er gratis, og rigtig udemærket, og hjælpen indeholder også en god oversigt over de tags du kan bruge.

Det kan hentes her :
http://ndoc.sourceforge.net
Avatar billede _et Praktikant
24. juli 2004 - 00:21 #4
snepnet -> Det var lige det. :-)

points til dig.
Avatar billede snepnet Nybegynder
24. juli 2004 - 00:29 #5
Hej _et :o)

Jeg skrev egentlig kun fordi jeg ikke lige umiddelbart kunne se det i det dokument 2c postede et link til, men jeg har efterfølgende kigget lidt bedre i det, og det står sådan set i pdf-en.
Såhh... Det er nok mest rimeligt hvis du giver ham/hende pointene, eller i hvert fald splitter dem op :o)

Har du prøvet NDoc ?

Mvh
Avatar billede _et Praktikant
29. juli 2004 - 13:10 #6
;-) 

Tak til jer begge
Avatar billede Ny bruger Nybegynder

Din løsning...

Tilladte BB-code-tags: [b]fed[/b] [i]kursiv[/i] [u]understreget[/u] Web- og emailadresser omdannes automatisk til links. Der sættes "nofollow" på alle links.

Loading billede Opret Preview
Kategori
IT-kurser om Microsoft 365, sikkerhed, personlig vækst, udvikling, digital markedsføring, grafisk design, SAP og forretningsanalyse.

Log ind eller opret profil

Hov!

For at kunne deltage på Computerworld Eksperten skal du være logget ind.

Det er heldigvis nemt at oprette en bruger: Det tager to minutter og du kan vælge at bruge enten e-mail, Facebook eller Google som login.

Du kan også logge ind via nedenstående tjenester