Jeden komentarz = jeden problem

Lepiej nie umieszczać dwóch komentarzy (problemów, pytań) w jednej linii oddzielonej przecinkiem. Nawet gdy są powiązane (One zawsze są powiązane, przecież dotyczą tej samej linijki kodu która jest pod nimi).

Sugeruje to tylko jeden problem, podczas gdy w rzeczywistości może ich być więcej (szybciej wizualnie jesteśmy w stanie ocenić sytuację). Dziś gdy rozwiązałem problem, standardowo skasowałem całą linijkę (Shift+DEL). Zgubiłem problem, którego nie powinienem był zgubić. Zmyślony przykład:

public void Bar()
{
    string path = @"";

    // Remove unused parameter, update method name, make relevant to changes to BarFromPath()
    FooFromPath(path);
}
Advertisements
Ten wpis został opublikowany w kategorii Tip of the day i oznaczony tagami . Dodaj zakładkę do bezpośredniego odnośnika.