Domande taggate «documentation-generation»

1
Duplicazione della documentazione sulle implementazioni / sostituzioni dell'interfaccia buona o cattiva?
Quindi abbiamo un'interfaccia simile /// <summary> /// Interface for classes capable of creating foos /// </summary> public interface ICreatesFoo { /// <summary> /// Creates foos /// </summary> void Create(Foo foo); /// <summary> /// Does Bar stuff /// </summary> void Bar(); } Di recente, abbiamo riprodotto una storia di documentazione che …
8
Dove mettere la documentazione del codice?
Attualmente sto usando due sistemi per scrivere la documentazione del codice (sto usando C ++): La documentazione relativa ai metodi e ai membri della classe viene aggiunta accanto al codice, utilizzando il formato Doxygen. Su un server Doxygen viene eseguito sulle fonti in modo che l'output possa essere visualizzato in …
Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.