Hej,
Zastanawia mnie sprawa komentowania kodu w C# - przypuśćmy na przykład taką sytuację:
/// <summary>
/// Instancja terminala.
/// </summary>
private Terminal terminal;
/// <summary>
/// Instancja terminala.
/// </summary>
public Terminal Terminal { get { return terminal; } }
Jak w taki sposób uniknąć dublowania komentarzy, poza zbiciem tego w jedno pole?
Pozdrawiam!
Może tak:
#region Instancja terminala
private Terminal terminal;
public Terminal Terminal { get { return terminal; } }
#endregion
W takim wypadku nie ma podpisu przy najechaniu kursorem np. na zmienną tego typu, czyli niewiele to daje.
A po co w ogóle summary przy polu prywatnym? Jak trzeba wyjaśnić po co jest to pole to zwykły komentarz wystarczy.
@Rev: też jakaś opcja, jednak chciałem zachować to takie fajne podsumowanie po najechaniu myszką nad identyfikator w Visual Studio :P
To <value> zrób: https://msdn.microsoft.com/en-us/library/azda5z79.aspx
Patryk27 napisał(a):
@Rev: też jakaś opcja, jednak chciałem zachować to takie fajne podsumowanie po najechaniu myszką nad identyfikator w Visual Studio :P
Ktoś kiedyś z tego skorzysta? Jaką to wnosi wartość do kodu?
Kod ma się komentować sam, dokumentacja XML ma sens tylko dla publicznego API.