Jak formatujecie kod?

pytanie zadane 9 kwietnia 2018 w Offtop przez Hiskiel Pasjonat (22,830 p.)
edycja 9 kwietnia 2018 przez Hiskiel

Witam!

Taki offtop. Ciekawi mnie jak formatujecie kod. Wiem, że każdy to robi inaczej. Interesują mnie dokładnie:

- ułożenie nawiasów klamrowych (pythonowcy sio ;d). U mnie to zawsze wygląda tak:

int main(...)
{
//zawsze tak main
}

void OtherFunction(){
//inna funkcja
}

czyli main ma zawsze takie "C++'owe ułożenie klamer" a inne funkcje Javowe.

- jak zapisujecie nazwy zmiennych i funkcji. U mnie:

int variable;
int OtherVariable;
int IAV; //IAmVariable


void func(){}
void OtherFunction(){}
void IAF(){} //IAmFunction

nie ma co tłumaczyć.

- zapisywanie wyrażeń w nawiasach. Po mojemu:

if(a == b)  //zawsze ze spacjami
 
if((a == b)&&(c == d)) //czyli operatory AND i OR zawsze blisko jakichś zmiennych/nawiasów

- jakie taby robicie? Ja zawsze preferuję 4 spacjowe. Wiem, że ludzie wolą głównie 3, 4 i 6

Jakieś inne oryginalne formatowanie kodu? Podzielcie się!

komentarz 9 kwietnia 2018 przez Ehlert Ekspert (212,670 p.)

Podaję hasło: linter.

8 odpowiedzi

odpowiedź 9 kwietnia 2018 przez Wiciorny Ekspert (269,710 p.)

Wbijam w Intelij IDE - puszczam ctr+alt+L i niech się dzieje wola BOŻA :)

1	komentarz 9 kwietnia 2018 przez Typowy Janusz Dyskutant (8,150 p.) Prawidłowe podejście do tematu Pozdrawiam!

odpowiedź 9 kwietnia 2018 przez Mariusz08 Maniak (62,300 p.)

W PHP stosuje się standard PSR-2.

komentarz 9 kwietnia 2018 przez Hiskiel Pasjonat (22,830 p.)

Ale mnie nie interesuje standard. Mimo iż w c++ powinno się tak "formatować" nawiasy jak mam w main, to robię większość javowo

komentarz 9 kwietnia 2018 przez Eryk Andrzejewski Mędrzec (164,260 p.)

A kto powiedział, że akurat tak się powinno robić?

Rób jak uważasz, ważne żeby trzymać się jednej konwencji w jednym projekcie. A to czy w swoim projekcie będziesz stawiał klamry tak, czy tak - nikomu nic do tego. No chyba, że chcesz, aby ktoś inny pomógł Ci naprawić jakiś problem, a nie robisz wcięć, lub robisz je niedbale.

komentarz 9 kwietnia 2018 przez Knayder Nałogowiec (37,640 p.)

@Swipeyro, Nie ma czegoś takiego ja standard w formatowaniu kodu. Pisz jak ci wygodnie. Jak kiedyś dołączysz do jakiegoś teamu, to zaczniesz pisać zgodnie z ich Style Guidem. Zadajesz strasznie dużo pytań na tym forum. Sugerowałbym naukę korzystania z googla, zamiast skupiać się na tak nie istotnych rzeczach jak style formatowania kodu.

komentarz 9 kwietnia 2018 przez Hiskiel Pasjonat (22,830 p.)

Proszę Cię, nie bądź sztywny. Gdy człowieka czyta takie komentarze, to naprawdę, aż chce się wziąć i wyłączyć komputer. Rozumiem, że krytyka jest ważna, ale nie widzę problemu w zadaniu zwykłego pytania, tymbardziej w offtop. "Użyj google" jakoś wątpię, że gdybym wpisał "formatowanie kodu <imię i nazwisko/pseudonim" lub "code formating <imię i nazwisko/pseudonim" uzyskałbym coś ciekawego.

Jeśli Cię uraziłem, to przepraszam, ale empatia czy uczucia/emocje nie są moją mocną stroną.

1	komentarz 9 kwietnia 2018 przez Mariusz08 Maniak (62,300 p.) @Knayder, Mylisz się. PSR-2 jest standardem pisania kodu (jak pisać klamry, jakie nazwy nadawać zmiennym etc.), który obowiązuje w PHP.

komentarz 9 kwietnia 2018 przez Eryk Andrzejewski Mędrzec (164,260 p.)

@Mariusz08,

Ale korzystanie z PSR-2 nie jest wymogiem (mam tutaj na myśli jakieś własne projekty), lecz dobrą praktyką. Jeżeli ktoś bardzo nie chce go stosować i nie zamierza nigdy, przenigdy rozwijać innych niż swoje projektów, no to nie widzę powodu, żeby tego mógł nie robić.

komentarz 9 kwietnia 2018 przez Knayder Nałogowiec (37,640 p.)

Swipeyro pisał o C++, a nie PHP

komentarz 9 kwietnia 2018 przez Knayder Nałogowiec (37,640 p.)

A co do ciebie Swipeyro, to chyba naprawdę lepiej zrobisz jak wyłączysz komputer.
Twoje pytanie:
https://forum.pasja-informatyki.pl/339705/c-typ-void-gdzie-po-co
Naprawdę ciężko wpisać w google: "c++ zmienna void", "C++ void variable". Daleko nie zajedziesz jako programista, jeżeli nie będzie potrafił szukać odpowiedzi w necie.
Założyłem konto na tym forum kiedy zaczynałem przygodę z c++ (Czyli ogólnie programowaniem), a ilość pytań jakie zadałem, są niczym w porównaniu do ilości pytań jakie ty zdałeś. (10 razy więcej ich masz). Lepiej wyjdzie dla ciebie, jeżeli nauczysz się korzystać z googla.

komentarz 9 kwietnia 2018 przez Hiskiel Pasjonat (22,830 p.)

Z googla korzystam, jednakże nawet w tym muszę się jeszcze uczyć. Najczęściej mam problem z formułowaniem fraz. Jeśli miałbyś uczyć kogoś, to dobrym nauczycielem byś nie był. Łatwo przy Tobie można się zniechęcić (na szczęście 4 lata nękania w szkole uczynily mnie odpornym psychicznie na.. wszystko). Pytania. Pytania są kluczem do wiedzy. Gdyby nie pytania, to dalej siedziałbym przed IDE zastanawiając się czemu kod z najprostszego zadania ze SPOJa mi nie działa.

komentarz 9 kwietnia 2018 przez Knayder Nałogowiec (37,640 p.)

Ty no patrz jaka magia. Skopiowałem tytuł twojego posta:
https://i.imgur.com/S1TOVip.jpg
I patrz co znalazłem:
https://i.imgur.com/5e4RUBy.jpg

Jakbym miał cie uczyć, to bym cię uczył. Jeżeli ktoś po odrobinie krytyki miałby rzucić programowanie, to niech od razu zmyka z czegokolwiek co ma związek z kreatywnością, bo jednak krytykę to trzeba umieć przyjąć i zaadaptować....
Nie wymiguj się tym że nie potrafisz zadać pytania googlowi. Używasz najprostszych słów i działa:

hmm, słyszałem o czymś takim jak template w c++, co to może być. Już wiem wpisze w google (C++ template)... O proszę już wszystko wiem.

hmm, słyszałem o czymś takim jak template w c++, co to może być. www.pasja.informatyki.pl. "Co to jest template" bla bla bla 10 minut pisania posta.... Ok wstawione, teraz tylko poczekać 10 minut na odpowiedź... hmm, dalej nie kumam, słabo tłumaczy ten gościu który odpowiedział. Gdyby tylko istniał gdzieś na necie poradnik do templateów :(

Zgadnij kto z tych dwóch użytkowników jest mądrzejszy ;)

komentarz 9 kwietnia 2018 przez Hiskiel Pasjonat (22,830 p.)

Chyba czegoś nie rozumiesz. Krytyka jest najważniejsza w zdobywaniu doświadczenia, zgadzam się. Ten screen który pokazałeś - bezsens. Prosiłem o DOKŁADNE wytłumaczenie co to za typ i jakie są jego zastosowania. Jeśli miałbyś być psychologiem, też by Ci się za bardzo nie udało. Analizuje się dużo danych, a nie tylko to co teraz i w tej chwili (przynajmniej w tym przypadku). Napisałem również wyraźnie "mam problem z formułowaniem fraz". Czy serio myślisz, że nie potrafiłbym wpisać w google dwa słowa? 3/4 mojego rozwiązywania problemów to google. Zostało przezemnie napisane tyle programów, o których ludzie z tego forum by nawet by nie pomyśleli, że nie zliczę. Ja krytykę przyjmuję, nie wiem na kogo patrzyłeś, oceniając mnie tak. Jeśli masz w ten sposób oceniać innych, to nie widzę Cię w roli psychologa.

komentarz 9 kwietnia 2018 przez Knayder Nałogowiec (37,640 p.)

xD Co ty mi tu z psychologią wyjeżdżasz. Pewnie że bym nie mógł być psychologiem, bo jestem zbyt bezpośredni. Nie będę ci lał wody, jak to fajnie ze sobie programujesz, ale powinieneś troszeczkę, ciupinkę się postarać poszukać jednak w googlu, bo trochę za dużo się pytasz.
Nie, ja ci po prostu napisze żebyś zaczął używać googla i jeszcze cie troche zdenerwuję, to na pewno sobie o mnie zapamiętasz. I nie mów ze pisałeś TYYLE projektów z użyciem samego googla, bo twoje pytanie świadczą o czymś innym (No chyba że u ciebie problemem jest error typu "Missing ; in line 21" i wtedy tylko używasz googla)... Przestań lać wodę i następnym razem jak nie będziesz czegoś wiedział, to kurde wpisz to w google i poszukaj przez więcej niż 5 minut. Przynajmniej godzinę. Szukaj głównie po Angielsku.

komentarz 9 kwietnia 2018 przez Hiskiel Pasjonat (22,830 p.)

Czytanie ze zrozumieniem - podstawówka

"Mam problem z sformułowaniem fraz" nie z szukaniem jako takim. I jakim prawem oceniasz mnie na podstawie postów z forum? Gdybyś mógł, prosiłbym Cię o wytłumaczenie mi z jakich danych według Ciebie wynika, iż nie powodzi mi się w tym co robię? Chciałem Ci przez tą dlugą (w zasadzie nie wiem czemu) konwersację uswiadomomić, że dla ludzi naprawdę początkujących, takich totalnych laików byłbyś zmorą. Wiele ludzi (a tymbardziej z płci żeńskiej) bierze wszystko do siebie. Takie osoby mogą się łatwo zniechęcić jednym komentarzem typu "nie widzę Cię w tym".

PS mnie nie zdenerwujesz ;>

komentarz 9 kwietnia 2018 przez Hiskiel Pasjonat (22,830 p.)

Wiem, że chcesz mnie czegoś nauczyć, ale jak piszę - dla osób które są totalnymi laikami w tej dziedzinie (nie piszę. że jestem jakimś ekspertem, bo jeszcze w kij wiedzy przede mną, ale coś tam już wiem), a tym bardziej młodsze z każdych trochę ostrzejszych słów krytyki mogą się zniechęcić.

komentarz 9 kwietnia 2018 przez Beginer Pasjonat (22,110 p.)

Nie można w ten sposób podchodzić do sprawy. To forum jest do zadawania pytań - różnego typu i rodzaju. Ludzie tu obecni mają różny stopień wiedzy i umiejętności. Mają też bardzo b.różne osobowości i sposoby ekspresji. Mamy nawet kilku celebrytów, dla których forum jest wspaniałą platformą prezentacji. Gdyby nie ludzie, ich pytania, problemy, to forum by nie istniało. (Nie po to mądrzy ludzie je wymyślili i zbudowali.)

Forum pełni również rolę portalu towarzyskiego, społecznośiowego, czadami gry towarzyskiej, gdzie jest codzienny kontakt z żywymi, zaprzyjaźnionymi ludźmi; można wymienić poglądy i opinie, a nawet się posprzeczać. Tych funkcji, potrzeb nie załatwia Google. Z tych między innymi powodów jest to najlepiej działające w Polsce forum (nie tylko w dziedzinie informatyki).

komentarz 9 kwietnia 2018 przez Knayder Nałogowiec (37,640 p.)

No do pytań, ale może nie takich, które pojawiły sie juz dziesiątki razy, w 15 językach na 20 forach... Wystarczy wpisać w googla. A jeżeli ktoś się zniechęci do czegoś, bo ktoś inny na niego nakrzyczał to jprdl idź pan w **** i tak nic ciekawego nie wniesiesz. Bo pierwsza lepsza krytyka i kurde ucieka z branży xD Sam powiedziałeś że nie jesteś laikiem. Laikowi bym tak nie pisał. Zadałeś 170 pytań. Sory cos już musisz wiedzieć i ktoś ci w końcu musi uświadomić to, że jednak najpierw wpisz coś w google. Nie uogólniaj. Piszę do ciebie. Nie przekierowuj moich słów na innych. Odnieś się do tego, jako ty, a nie grupa laików.

odpowiedź 9 kwietnia 2018 przez Beginer Pasjonat (22,110 p.)
edycja 9 kwietnia 2018 przez Beginer

Ja preferuję (i namawiam) do stosowania klamer jakie pokazałeś w main() - tzn. stosowanych w C++, a nie w Javie. System klamer stosowany w C++ zapewnia dużo większą przejrzystość, czytelność kodu. System stosowany w Javie, co prawda pozwala zaoszczędzić 1-2 linijki, ale znacząco pogarsza czytelność kodu.

W nazwach zmiennych i funkcji stosujemy system tzw. caseCamel. Zmienne zaleca się rozpoczynać z małej litery, natomiast funkcje z dużej litery. Stałe const dobrze jest oznaczać samymi dużymi literami.

Wcięcia są ważne, ponieważ bardzo poprawiają czytelność kodu. Zwykle wystarczają 3-4 spacje. Niektóre środowiska (IDE) mają automatyczny system wcięć. Wtedy wcięcia są jeszcze większe.

System nawiasów, znaków porównania (rozmieszczenie kodu w poziomie), jaki pokazałeś, jest wzorcowy.

komentarz 9 kwietnia 2018 przez Ehlert Ekspert (212,670 p.)

System klamer stosowany w C++ zapewnia dużo większą przejrzystość, czytelność kodu. System stosowany w Javie, co prawda pozwala zaoszczędzić 1-2 linijki, ale znacząco pogarsza czytelność kodu.

To jest już kwestia osobistych preferencji. W Js długo tak nie popiszesz.

odpowiedź 9 kwietnia 2018 przez Alex.Ironside Stary wyjadacz (14,900 p.)

odpowiedź 9 kwietnia 2018 przez Patryk Krajewski Nałogowiec (26,170 p.)

Wszystko zależy od projektu. Jeśli widzę, że kod jest sformatowany w dany sposób to sam tak dalej próbuje pisać. A przy własnym kodzie to formatowanie wybieram te do którego najbardziej przywykłem

komentarz 9 kwietnia 2018 przez Hiskiel Pasjonat (22,830 p.)

I właśnie o to do którego bardziej przywykłeś pytam.

odpowiedź 9 kwietnia 2018 przez mokrowski Mędrzec (155,460 p.)

Zainteresuj się programem astyle : http://astyle.sourceforge.net/

Jest jeszcze o wiele więcej narzędzi do formatowania. W nim jednak widać różne style formatowania więc wyrobisz sobie zdanie. Użycie proste :)

astyle --style=TU_STYL program.cpp

komentarz 9 kwietnia 2018 przez Secrus Nałogowiec (32,880 p.)

Nie wiem jak inne edytory, ale C::B ma wbudowany program domyślnie

odpowiedź 9 kwietnia 2018 przez Dorion300 Szeryf (90,250 p.)

odpowiedź 10 kwietnia 2018 przez kap Stary wyjadacz (11,620 p.)
edycja 10 kwietnia 2018 przez kap

Tak jak lubię, jak mi w danej chwili wygodnie. Pod git hooka mam podpięty autoformatter, wiec kod do repo trafia zawsze identycznie sformatowany. Ustawienia autoformattera i dodanie git hooków są w repo projektu, więc każdy w zespole ma ten sam flow - nie da się niechcący wrzucić źle sformatowanego kodu - polecam.

PS
Jak ktoś chce konkret to dla JSa używam Prettier + Husky

PPS
Używanie klasycznego lintera do formatowania to nie jest optymalne rozwiązanie