Sto cercando il formato informativo della documentazione di classe per le mie classi Entity, Business Logic e Data Access.
Ho trovato seguenti due formati da qui
Formato 1
///-----------------------------------------------------------------
/// Namespace: <Class Namespace>
/// Class: <Class Name>
/// Description: <Description>
/// Author: <Author> Date: <DateTime>
/// Notes: <Notes>
/// Revision History:
/// Name: Date: Description:
///-----------------------------------------------------------------
Formato 2
// ===============================
// AUTHOR :
// CREATE DATE :
// PURPOSE :
// SPECIAL NOTES:
// ===============================
// Change History:
//
//==================================
Ritengo che i seguenti siano gli elementi di base
- Autore
- Data di creazione
- Descrizione
- Cronologia revisioni
come lo spazio dei nomi e il nome della classe ci saranno comunque.
Fammi sapere le tue opinioni, quale formato è raccomandato e se esiste un metodo standard per scrivere la cronologia delle revisioni?