Szukam pouczającego formatu dokumentacji klas dla moich klas Entity, Business Logic i Data Access.
Znalazłem następujące dwa formaty stąd
Format 1
///-----------------------------------------------------------------
/// Namespace: <Class Namespace>
/// Class: <Class Name>
/// Description: <Description>
/// Author: <Author> Date: <DateTime>
/// Notes: <Notes>
/// Revision History:
/// Name: Date: Description:
///-----------------------------------------------------------------Format 2
// ===============================
// AUTHOR :
// CREATE DATE :
// PURPOSE :
// SPECIAL NOTES:
// ===============================
// Change History:
//
//==================================Wydaje mi się, że następujące są podstawowe elementy
- Autor
- stworz Date
- Opis
- Historia zmian
tak czy inaczej będzie tam nazwa i nazwa klasy.
Daj mi znać, jaki format jest zalecany i czy istnieje standardowy sposób pisania historii zmian?
8
Historia wersji, jeśli używasz jakiejś formy VCS, jest moim zdaniem zajęta. Umieszczając go tutaj, dodaje kolejne miejsce, o którym należy pamiętać, aby udokumentować, dlaczego nie pozwolić VCS zrobić to za Ciebie i zachować dokumentację kodu tak zwięzłą, jak to możliwe.
—
Chris,
Autor i data utworzenia są również obsługiwane przez kontrolę źródła. Wszystko czego potrzebujesz to opis.
—
Mike Seymour,