Tworzenie dokumentacji w C# - coś podobnego do javadoc

2014-05-17 19:12
0

Witam,
Jak stworzyć w C# dokumentację, coś podobnego jak w javie jest javadoc. Na razie znalazłem tylko generowanie dokumentacji do postaci XML, co nie wydaję mi zbyt czytelne. W wymaganiach projektu na zaliczenie jest dostarczenie dokumentacji, tylko nie za bardzo wiem co opisać. Może jest jakiś dodatek do VS który wygeneruję taką dokumentację jak jest na MSDN?
Weźmy na przykład taką prostą klasę i nad czym tu się rozpisywać? Mam jeszcze parę takich klas i jedną do komunikacji z bazą danych (w tej już może się coś znajdzie do opisania).

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace HCompany
{
    public class Person
    {
        protected string id;
        protected string name;
        protected string lastName;
        protected string email;
        protected string cellPhone;

        /// <summary>
        /// 
        /// </summary>
        /// <param name="id"></param>
        /// <param name="name"></param>
        /// <param name="lastName"></param>
        /// <param name="email"></param>
        /// <param name="cellPhone"></param>
        public Person(string id, string name, string lastName, string email, string cellPhone)
        {
            this.id = id;
            this.name = name;
            this.lastName = lastName;
            this.email = email;
            this.cellPhone = cellPhone;
        }

        public string Id
        {
            get { return id; }
            set { id = value; }
        }

        /// <summary>
        /// Name property. </summary>
        /// <value>
        /// A value tag is used to describe the property value.</value>
        public string Name
        {
            get {return name;}
            set { name = value;}
        }

        public string LastName
        {
            get { return lastName; }
            set { lastName = value; }
        }

        public string Email
        {
            get { return email; }
            set { email = value; }
        }

        public string CellPhone
        {
            get { return cellPhone; }
            set { cellPhone = value; }
        }
    }
}

Pozostało 580 znaków

2014-05-17 19:15

http://www.stack.nl/~dimitri/doxygen/

Sa jeszcze jakies toolsy targetowane na .NET, ale nie sprawdzone:
http://sandcastle.codeplex.com/
https://shfb.codeplex.com/

edytowany 1x, ostatnio: n0name_l, 2014-05-17 19:21

Pozostało 580 znaków

2014-05-17 19:25
Adamsssssssssss
0

dokumentacja != javadoc
Powinieneś zamiast javadoca napisać Software Design Specification (opis systemu, tego jak działa, co z czym się komunikuje i jak) w taki sposób, aby nowa osoba, która miałaby dołączyć do zespołu wiedziała jak projekt działa.

Pozostało 580 znaków

2014-05-17 20:12
0

@n0name_l dzięki. Próbuję teraz użyć tego narzędzia. W VS mam zaznaczone generowanie dokumentacji XML. Naciskam F5, projekt się kompiluję, oczywiście dostaję dużo ostrzeżeń, że nie wszystkie klasy mają komentarze itp. Teraz włączam doxywizard. Podaję ścieżkę: E:/Program Files/doxygen/bin . Wybieram source code directory i wskazuje tam ścieżkę do projektu. Mode zmieniam na C#. Potem zakładka Run, klikam run doxygen, wykona się biorę show HTML output, ale strona jest pusta. Nie ma nawet spisu klas. Co robię źle?


        /// <summary>
        /// The Constructor
        /// </summary>
        /// <param name="id">identity card number</param>
        /// <param name="name">Name of person</param>
        /// <param name="lastName">Lastname of person</param>
        /// <param name="email">email</param>
        /// <param name="cellPhone">Number of cellphone</param>
        public Person(string id, string name, string lastName, string email, string cellPhone)
        {
            this.id = id;
            this.name = name;
            this.lastName = lastName;
            this.email = email;
            this.cellPhone = cellPhone;
        }
Doxygen ma inna skladnie komentowania. Sprawdz najpierw te 2 narzedzia nizej, bo one sie 'integruja' jakos tam z tym co generuje Ci VS. A tak poza tym to teraz nie mam zbytnio jak testowac, wiec odpisuje w komentarzu :P - n0name_l 2014-05-17 20:18

Pozostało 580 znaków

Liczba odpowiedzi na stronę

1 użytkowników online, w tym zalogowanych: 0, gości: 1, botów: 0