Formatowanie kodu do 80 kolumn, zawijanie przypisań zmiennych

Formatowanie kodu do 80 kolumn, zawijanie przypisań zmiennych
Kamil Raju
  • Rejestracja:ponad 6 lat
  • Ostatnio:prawie 5 lat
  • Postów:77
0

Robię refactor kodu i skracam m.in. linijki ciągnące się na niczym kolej transsyberyjska. Przy niektórych wierszach, złapała mnie jednak wątpliwość. Poniższa linijka znajduje się w 3 zagnieżdżeniu klamer (QML) i razem z białymi znakami sięga 96 kolumny.

Kopiuj
var questionTransContent = Parser.splitTextFromSynthesizer(questionTrans.question); 

Skróciłem już wszystkie nazwy możliwe najbardziej, bez utraty ich znaczenia. Mogę teraz zrobić dwie rzeczy:

  1. Krótsze, mniej opisowe zmienne:
Kopiuj
var qTransContet = Parser.split(qTrans.question); 
  1. Zwijanie linii i zaburzenie estetyki kod i sposobu w jaki wodzi się po nim wzrokiem.
Kopiuj
var questionTransContent = 
                   Parser.splitTextFromSynthesizer(questionTrans.question); 

Które rozwiązanie jest według was lepsze?

serek
  • Rejestracja:około 11 lat
  • Ostatnio:2 minuty
  • Postów:1471
1

Zostaw tak jak masz. Nadal jest to czytelne. Limit 80 znaków to raczej tylko propozycja usprawnienia, a nie twarda reguła.

Cytując z PSR 2:
There MUST NOT be a hard limit on line length; the soft limit MUST be 120 characters; lines SHOULD be 80 characters or less.

Zacząłbym się dopiero martwić, gdyby linia kodu miała już te 120 znaków lub więcej.

edytowany 4x, ostatnio: serek
Kamil Raju
Chciałbym określić jakąś twardą konwencję, bo 'sugestiami' mało kto się przejmuje. Ale chyba rzeczywiście zacznę od 120.
mr_jaro
  • Rejestracja:ponad 13 lat
  • Ostatnio:około 3 lata
  • Lokalizacja:Grudziądz/Bydgoszcz
  • Postów:5300
0

osobiście uważam, że 80 to strasznie mało, w firmie stosujemy limit na 120


It's All About the Game.
Kamil Raju
Pierwszy senior z którym pracowałem, świetny programista swoją drogą, odrzucał code review na zasadzi "linijka 64 jest niekompletna". Jak to niekompletna?!? A no tak, że 'Mój laptop wyświetla tylko 80 kolumn i 500 wierszy, resztę zjada Cthulhu.' (miał Cthulhu na tapecie). W połączeniu z hypem na c++11 i jego 'zwięzłą' składnią, czasami dłużej się kod formatowało niż pisało :D.
mr_jaro
@Kamil Raju no u mnie szefostwo miało pomysł na 80 a seniorzy przeforsowali sami limit na 120
mr_jaro
@Kamil Raju jeśli ten senior siedzi na lapku z malutkim ekranikiem to już jego problem, dziś siedzimy na ekranach minimum fullhd a coraz więcej osób z mojego otoczenia przechodzi na wqhd, miejsca jest mase po bokach, a sam kod nie jest bardzo nieczytany, bardziej nieczytelne jest dla mnie zawijanie wywołania jednej metody bo sie nie mieści lista parametrów.
Kamil Raju
@mr_jaro Nie, nie, miał normalny komputer i środowisko. Tylko z góry narzucał ograniczenia w stylu 80 linii, max 3 parametry do funkcji, zero singletonów, zero czystych wskaźników itd.. Sporo się w sumie nauczyliśmy.
Kliknij, aby dodać treść...

Pomoc 1.18.8

Typografia

Edytor obsługuje składnie Markdown, w której pojedynczy akcent *kursywa* oraz _kursywa_ to pochylenie. Z kolei podwójny akcent **pogrubienie** oraz __pogrubienie__ to pogrubienie. Dodanie znaczników ~~strike~~ to przekreślenie.

Możesz dodać formatowanie komendami , , oraz .

Ponieważ dekoracja podkreślenia jest przeznaczona na linki, markdown nie zawiera specjalnej składni dla podkreślenia. Dlatego by dodać podkreślenie, użyj <u>underline</u>.

Komendy formatujące reagują na skróty klawiszowe: Ctrl+B, Ctrl+I, Ctrl+U oraz Ctrl+S.

Linki

By dodać link w edytorze użyj komendy lub użyj składni [title](link). URL umieszczony w linku lub nawet URL umieszczony bezpośrednio w tekście będzie aktywny i klikalny.

Jeżeli chcesz, możesz samodzielnie dodać link: <a href="link">title</a>.

Wewnętrzne odnośniki

Możesz umieścić odnośnik do wewnętrznej podstrony, używając następującej składni: [[Delphi/Kompendium]] lub [[Delphi/Kompendium|kliknij, aby przejść do kompendium]]. Odnośniki mogą prowadzić do Forum 4programmers.net lub np. do Kompendium.

Wspomnienia użytkowników

By wspomnieć użytkownika forum, wpisz w formularzu znak @. Zobaczysz okienko samouzupełniające nazwy użytkowników. Samouzupełnienie dobierze odpowiedni format wspomnienia, zależnie od tego czy w nazwie użytkownika znajduje się spacja.

Znaczniki HTML

Dozwolone jest używanie niektórych znaczników HTML: <a>, <b>, <i>, <kbd>, <del>, <strong>, <dfn>, <pre>, <blockquote>, <hr/>, <sub>, <sup> oraz <img/>.

Skróty klawiszowe

Dodaj kombinację klawiszy komendą notacji klawiszy lub skrótem klawiszowym Alt+K.

Reprezentuj kombinacje klawiszowe używając taga <kbd>. Oddziel od siebie klawisze znakiem plus, np <kbd>Alt+Tab</kbd>.

Indeks górny oraz dolny

Przykład: wpisując H<sub>2</sub>O i m<sup>2</sup> otrzymasz: H2O i m2.

Składnia Tex

By precyzyjnie wyrazić działanie matematyczne, użyj składni Tex.

<tex>arcctg(x) = argtan(\frac{1}{x}) = arcsin(\frac{1}{\sqrt{1+x^2}})</tex>

Kod źródłowy

Krótkie fragmenty kodu

Wszelkie jednolinijkowe instrukcje języka programowania powinny być zawarte pomiędzy obróconymi apostrofami: `kod instrukcji` lub ``console.log(`string`);``.

Kod wielolinijkowy

Dodaj fragment kodu komendą . Fragmenty kodu zajmujące całą lub więcej linijek powinny być umieszczone w wielolinijkowym fragmencie kodu. Znaczniki ``` lub ~~~ umożliwiają kolorowanie różnych języków programowania. Możemy nadać nazwę języka programowania używając auto-uzupełnienia, kod został pokolorowany używając konkretnych ustawień kolorowania składni:

```javascript
document.write('Hello World');
```

Możesz zaznaczyć również już wklejony kod w edytorze, i użyć komendy  by zamienić go w kod. Użyj kombinacji Ctrl+`, by dodać fragment kodu bez oznaczników języka.

Tabelki

Dodaj przykładową tabelkę używając komendy . Przykładowa tabelka składa się z dwóch kolumn, nagłówka i jednego wiersza.

Wygeneruj tabelkę na podstawie szablonu. Oddziel komórki separatorem ; lub |, a następnie zaznacz szablonu.

nazwisko;dziedzina;odkrycie
Pitagoras;mathematics;Pythagorean Theorem
Albert Einstein;physics;General Relativity
Marie Curie, Pierre Curie;chemistry;Radium, Polonium

Użyj komendy by zamienić zaznaczony szablon na tabelkę Markdown.

Lista uporządkowana i nieuporządkowana

Możliwe jest tworzenie listy numerowanych oraz wypunktowanych. Wystarczy, że pierwszym znakiem linii będzie * lub - dla listy nieuporządkowanej oraz 1. dla listy uporządkowanej.

Użyj komendy by dodać listę uporządkowaną.

1. Lista numerowana
2. Lista numerowana

Użyj komendy by dodać listę nieuporządkowaną.

* Lista wypunktowana
* Lista wypunktowana
** Lista wypunktowana (drugi poziom)

Składnia Markdown

Edytor obsługuje składnię Markdown, która składa się ze znaków specjalnych. Dostępne komendy, jak formatowanie , dodanie tabelki lub fragmentu kodu są w pewnym sensie świadome otaczającej jej składni, i postarają się unikać uszkodzenia jej.

Dla przykładu, używając tylko dostępnych komend, nie możemy dodać formatowania pogrubienia do kodu wielolinijkowego, albo dodać listy do tabelki - mogłoby to doprowadzić do uszkodzenia składni.

W pewnych odosobnionych przypadkach brak nowej linii przed elementami markdown również mógłby uszkodzić składnie, dlatego edytor dodaje brakujące nowe linie. Dla przykładu, dodanie formatowania pochylenia zaraz po tabelce, mogłoby zostać błędne zinterpretowane, więc edytor doda oddzielającą nową linię pomiędzy tabelką, a pochyleniem.

Skróty klawiszowe

Skróty formatujące, kiedy w edytorze znajduje się pojedynczy kursor, wstawiają sformatowany tekst przykładowy. Jeśli w edytorze znajduje się zaznaczenie (słowo, linijka, paragraf), wtedy zaznaczenie zostaje sformatowane.

  • Ctrl+B - dodaj pogrubienie lub pogrub zaznaczenie
  • Ctrl+I - dodaj pochylenie lub pochyl zaznaczenie
  • Ctrl+U - dodaj podkreślenie lub podkreśl zaznaczenie
  • Ctrl+S - dodaj przekreślenie lub przekreśl zaznaczenie

Notacja Klawiszy

  • Alt+K - dodaj notację klawiszy

Fragment kodu bez oznacznika

  • Alt+C - dodaj pusty fragment kodu

Skróty operujące na kodzie i linijkach:

  • Alt+L - zaznaczenie całej linii
  • Alt+, Alt+ - przeniesienie linijki w której znajduje się kursor w górę/dół.
  • Tab/⌘+] - dodaj wcięcie (wcięcie w prawo)
  • Shit+Tab/⌘+[ - usunięcie wcięcia (wycięcie w lewo)

Dodawanie postów:

  • Ctrl+Enter - dodaj post
  • ⌘+Enter - dodaj post (MacOS)