Ho 2 modelli, DTO e modelli di database (entità) che si associano al database.
Solitamente inserisco i commenti XML sopra le proprietà per descrivere a cosa servono.
class MyEntity
{
/// <summary>
/// Some summary
/// </summary>
public string SomeThing { get; set; }
}
Devo inserire questi commenti nei miei DTO o entità?
Se il DTO e l'entità vengono abbandonati in modo simile, non è necessario duplicare la documentazione, ma è possibile fare riferimento all'entità dal DTO e dalle sue proprietà.
Con il tag inheritdoc:
/// <summary>
/// Some summary
/// </summary>
class MyEntity
{
/// <summary>
/// Some summary
/// </summary>
public string SomeThing { get; set; }
/// <summary>
/// Some summary
/// </summary>
public int SomeThingElse { get; set; }
}
/// <summary>
/// Some summary <see cref="MyEntity"/>
/// </summary>
class MyDTO
{
/// <inheritdoc cref="MyEntity.SomeThing"/>
public string SomeThing { get; set; }
}
La funzione Aggiungi un modo per ereditare la documentazione # 313 sto usando .net framework versione 4.6.1 .
Non è ben documentato su dotnet solo per alcune petizioni nel vecchio link, ma con alcune estensioni o nuget pacakge che puoi usare anche se la tua versione dotnet non è supportata.
Leggi altre domande sui tag c# domain-driven-design comments documentation-generation dto