Czy nawiasy klamrowe powinny pojawiać się na własnej linii? [Zamknięte]

Czy nawiasy klamrowe powinny być na własnej linii, czy nie? Co o tym myślisz?

if (you.hasAnswer()) {
    you.postAnswer();
} else {
    you.doSomething();
}

a może powinno być

if (you.hasAnswer())
{
    you.postAnswer();
}
else
{
    you.doSomething();
}

lub nawet

if (you.hasAnswer())
    you.postAnswer();
else
    you.doSomething();

Bądź konstruktywny! Wyjaśnij dlaczego, dziel się doświadczeniami, poprzyj je faktami i referencjami.

Kiedy byłem studentem, umieszczałem nawiasy klamrowe w tym samym wierszu, aby było mniej wierszy, a kod był drukowany na mniejszej liczbie stron. Patrzenie na pojedynczy nawias drukowany jako jedyną rzecz w linii jest denerwujące. (środowisko, marnotrawstwo papieru)

Ale przy kodowaniu dużych aplikacji, dopuszczenie niektórych linii zawierających tylko nawiasy klamrowe jest przystępne, biorąc pod uwagę wrażenie grupowania.

Niezależnie od tego, który styl wybierzesz, zachowaj spójność, aby Twój mózg nie przetwarzał wielu stylów w powiązanych fragmentach kodu . W różnych scenariuszach (jak wyżej) powiedziałbym, że można używać różnych stylów, łatwiej jest „przełączać kontekst” na wysokim poziomie.

Nigdy nie powinieneś robić trzeciej metody.

Przeskakiwanie na nawiasach klamrowych może zaoszczędzić ci kilku naciśnięć klawiszy za pierwszym razem, ale następny koder, który pojawia się, dodaje coś do twojej klauzuli else, nie zauważając, że w bloku brakuje nawiasów klamrowych.

Napisz swój kod dla innych osób.

Przez długi czas twierdziłem, że są one jednakowej wartości lub tak bardzo bliskie równości, że możliwy zysk dzięki dokonaniu właściwego wyboru był znacznie, znacznie niższy niż koszt kłótni o to.

Będąc zgodny jest ważna , choć. Więc powiedziałem, rzućmy monetą i zacznijmy pisać kod.

Widziałem już wcześniej, że programiści nie chcą się tak zmieniać. Pokonaj to! Zmieniałem się wiele razy w mojej karierze. Używam nawet różnych stylów w moim C # niż w PowerShell.

Kilka lat temu pracowałem nad zespołem (~ 20 programistów), który postanowił poprosić o dane wejściowe, a następnie podjąć decyzję, a następnie egzekwować ją w całej bazie kodu. Będziemy mieli tydzień na podjęcie decyzji.

Dużo jęków i przewracających oczami. Wiele „Lubię swoją drogę, bo jest lepiej”, ale bez substancji.

Gdy badaliśmy drobne szczegóły pytania, ktoś zapytał, jak poradzić sobie z tym problemem w stylu brace-on-the-the-line:

void MyFunction(
    int parameterOne,
    int parameterTwo) {
    int localOne,
    int localTwo
}

Zauważ, że nie jest od razu oczywiste, gdzie kończy się lista parametrów, a zaczyna ciało. Porównać do:

void MyFunction(
    int parameterOne,
    int parameterTwo) 
{
    int localOne,
    int localTwo
}

Przeczytaliśmy, jak ludzie na całym świecie poradzili sobie z tym problemem, i znaleźliśmy wzór dodawania pustej linii po otwartym nawiasie:

void MyFunction(
    int parameterOne,
    int parameterTwo) {

    int localOne,
    int localTwo
}

Jeśli zamierzasz zrobić wizualną przerwę, równie dobrze możesz to zrobić za pomocą klamry. Wtedy twoje wizualne przerwy również stają się spójne.

Edycja : Dwie alternatywy dla rozwiązania „dodatkowej pustej linii” podczas korzystania z K&R:

1 / Wcięcie argumentów funkcji inaczej niż w treści funkcji

2 / Umieść pierwszy argument w tym samym wierszu co nazwa funkcji i dopasuj kolejne argumenty w nowych wierszach do tego pierwszego argumentu

Przykłady:

1 /

void MyFunction(
        int parameterOne,
        int parameterTwo) {
    int localOne,
    int localTwo
}

2 /

void MyFunction(int parameterOne,
                int parameterTwo) {
    int localOne,
    int localTwo
}

/Edytować

Nadal twierdzę, że spójność jest ważniejsza niż inne względy, ale jeśli nie mamy ustalonego precedensu , to właściwym rozwiązaniem jest brace-on-next-line.

Główne zasady to:

1. Postępuj zgodnie z istniejącym standardem kodowania projektu.
2. Jeśli nie ma standardu kodowania i edytujesz istniejącą bazę kodu należącą do kogoś innego - zachowaj spójność ze stylem istniejącego kodu, bez względu na to, jak bardzo go lubisz.
3. Jeśli pracujesz nad projektem typu green-field - dyskutuj z innymi członkami zespołu i osiągnij konsensus w sprawie formalnego lub nieformalnego standardu kodowania.
4. Jeśli pracujesz nad projektem typu green-field jako jedyny programista - podejmij decyzję, a następnie bądź bezwzględnie konsekwentny.

Nawet jeśli nie masz żadnych zewnętrznych ograniczeń, najlepiej (IMO) poszukać istniejącego (powszechnie używanego) standardu kodowania lub wytycznych dotyczących stylu i spróbować tego przestrzegać. Jeśli rzucisz własny styl, istnieje duża szansa, że ​​za kilka lat będziesz żałować.

Wreszcie styl, który jest implementowany / możliwy do wdrożenia przy użyciu istniejących kontrolerów stylów i formatatorów kodu, jest lepszy niż styl, który należy „wymusić” ręcznie.

Zaletą pierwszej metody jest to, że jest bardziej kompaktowa w pionie, dzięki czemu można zmieścić więcej kodu na ekranie i dlatego wolę. Jedynym argumentem, który usłyszałem na korzyść drugiej metody, jest to, że ułatwia ona parowanie nawiasów otwierających i zamykających, ale większość IDE ma do tego skrót klawiaturowy, a tak naprawdę jest to fałszywa instrukcja - zamiast parowania nawiasów otwierających z zamykającym nawias możesz sparować nawias zamykający z wyrażeniem „początek bloku” (jeśli, inaczej, przez chwilę) na tym samym poziomie wcięcia, więc równie łatwo jest ustalić, gdzie jest początek bloku.

Nie widzę powodu, aby marnować całą linię tylko na nawias, gdy poprzednia konstrukcja for / while / if już wizualnie wskazuje początek bloku.

To powiedziawszy, uważam, że nawias zamykający powinien znajdować się we własnej linii, ponieważ potrzebujemy czegoś, co wskazywałoby koniec bloku i jego strukturę wcięcia w widoczny sposób.

wolę

if (you.hasAnswer())
{
    you.postAnswer();
}
else
{
    you.doSomething();
}

koniec

if (you.hasAnswer()) {
    you.postAnswer();
} else {
    you.doSomething();
}

ponieważ wiersz you.postAnswer();jest znacznie łatwiejszy do odczytania i znalezienia na pierwszy rzut oka. Po drugie, wtapia się w linię powyżej ( you.hasAnswer()), przez co moje oczy muszą bardziej skupić się na czytaniu.

Wolę pierwszą metodę. Nawiasy klamrowe nie są warte oddzielnej linii.

Chodzi o to, że nawiasy klamrowe nie są ważne. Są tylko śmieciami składniowymi , które są absolutnie niepotrzebne do zrozumienia, do czego służy kod, jego celu i sposobu jego implementacji. Są tylko hołdem dla języków w starym stylu C, w których wizualne grupowanie operatorów było niemożliwe ze względu na mało dostępnego miejsca na ekranie.

Są języki (Python, Haskell, Ruby), które są w porządku bez nawiasów klamrowych. To tylko potwierdza, że ​​nawiasy klamrowe są śmieci i nie powinny zasłużyć na linię, jeśli to możliwe:

if (you.hasAnswer()){
    you.postAnswer();
}else{
    you.doSomething();
}

Użyj Pythona i całkowicie pomiń argument.

Pozycja nawiasów klamrowych powinna być

metadane

konfigurowalny w IDE przez programistę. W ten sposób te nieznośne nawiasy klamrowe w całym kodzie, niezależnie od autora, wyglądają tak samo.

To zależy.

Jeśli piszę w JavaScript lub jQuery, używam pierwszej formy:

jQuery(function($) { 
    if ($ instanceOf jQuery) { 
        alert("$ is the jQuery object!"); 
    } 
}); 

Ale jeśli koduję w C #, używam drugiej formy, ponieważ jest to kanoniczny sposób, aby to zrobić w C #.

public int CalculateAge(DateTime birthDate, DateTime now) 
{ 
    int age = now.Year - birthDate.Year; 
    if (now.Month < birthDate.Month 
        || (now.Month == birthDate.Month && now.Day < birthDate.Day)) 
        age--; 
    return age; 
} 

Pamiętaj, że twój przykład można napisać

if (you.hasAnswer())
    you.postAnswer();
else
    you.doSomething();

w C #.

Wolę pierwszy, ponieważ trudniej mi dostrzec błąd w tym przykładzie.

if (value > maximum);
{
    dosomething();
}

niż w tym przykładzie

if (value > maximum); {
    dosomething();
}

Po ; {prostu wygląda mi bardziej źle niż linia kończąca się, ;więc bardziej prawdopodobne jest, że to zauważę.

Wolę niewielki wariant 1)

if (you.hasAnswer()) {
    you.postAnswer();
} // note the break here
else {
    you.doSomething();
}

Dlaczego?

• Myślę zawsze umieszczanie nawiasów klamrowych na ich własnej linii zmniejsza czytelność. Mogę zmieścić tylko pewną ilość kodu źródłowego na ekranie. Styl wspornika 2) sprawia, że ​​algorytmy podnoszenia z wieloma zagnieżdżonymi pętlami i warunkami są boleśnie długie.

• Chcę elsejednak zacząć od nowej linii, ponieważ ifielse wizualnie należą do siebie. Jeśli przed nim znajduje się wspornik else, znacznie trudniej jest dostrzec, co należy do czego.

• 3) dyskwalifikuje się. Wszyscy wiemy, co złego może się stać, jeśli pominiesz nawiasy i zapomnisz o tym.