Javascript i wytyczne "czystego" kodu

Javascript i wytyczne "czystego" kodu
JU
  • Rejestracja:ponad 8 lat
  • Ostatnio:ponad 2 lata
  • Postów:75
0

W wolnej chwili chciałem się pobawić trochę javascriptem. Rozwiązuję sobie proste zadanka z codewarsów, żeby jakoś oswoić się ze skłądnią i mam nastepujacej treści pytanie. Rozwiązania przechodzą w zasadzie napisane w jakikolwiek sposób (z klamrami, bez, wcieciami, bez wcięć, z definiowaniem zmiennych varami, letami, bez itp.). Jak powinno się poprawnie pisać kod javascriptu, żeby było ładnie/poprawnie? Dla przykładu :

Kopiuj
function areYouPlayingBanjo(name) {
  if (name[0].toLowerCase() === 'r') {
    return name + ' plays banjo';
  } else {
    return name + ' does not play banjo';
  }
}

vs

Kopiuj
function areYouPlayingBanjo(name) {
  if (name[0].toLowerCase() === 'r')
    return name + " plays banjo"
  else
    return name + " does not play banjo"
}

vs

Kopiuj
function areYouPlayingBanjo(name) {
  if (name[0].toLowerCase() === 'r') return name + " plays banjo"
  else return name + " does not play banjo"
}

W pythonie kod bez zastosowania odpowiednich wcięć nie przejdzie - tutaj z tego co widzę wolna amerykanka... Jak to jest?

QB
  • Rejestracja:ponad 9 lat
  • Ostatnio:około 3 godziny
  • Lokalizacja:Lublin
  • Postów:170
2

Opcja nr 1 będzie najlepiej przyjęta przez osoby oglądające kod.
Opcja nr 2 ujdzie w ostateczności, choć brak średników to błąd który zostanie naprawiony przez kompilator
Opcja nr 3 większość odrzuci na code review

Swoją drogą sama metoda nie zwraca tego co sugeruje po nazwie.
Powinna zwracać true/false:

Kopiuj
function areYouPlayingBanjo(name) {
  name[0].toLowerCase() === 'r';
}

poza tym w nazwie funkcji jest YOU, podczas gdy teksty są w trzeciej osobie.
Tak więc nazwa metody powinna być np. userPlaysBanjo

potem w miejscu gdzie renderujesz stringi, byłoby:

Kopiuj
>= ES6:
userPlaysBanjo(name) ? `${name} plays banjo` : `${name} doesn't play banjo`;
<= ES5:
userPlaysBanjo(name) ? name + 'plays banjo' : name + 'doesn\'t play banjo';
edytowany 4x, ostatnio: qbns
JU
  • Rejestracja:ponad 8 lat
  • Ostatnio:ponad 2 lata
  • Postów:75
0

Swoją drogą sama metoda nie zwraca tego co sugeruje po nazwie.

Zgadzam się, ale to już nazwa funkcji, którą wymyślił twórca zadania.

Ogólnie to wkurzające jest, że kod bez klamer w ogóle przechodzi jeśli są one charakterystyczne dla języka. Cały czas odnosze się tu do pythona, który jeśli mówi, że coś wcinamy to musimy wciąć, bo kod nie przejdzie i wywali błąd. Tutaj po prostu można pisać na kilka różnych sposobów i w moim odczuciu nie jest to dobre rozwiązanie. Nic - trzeba będzie przywyknąć - na razie co bym nie dotknął innego niż python - nie podoba mi się;)

QB
W sumie nie wiem jak brak klamer jest rozwiązywany na poziomie kompilatora. Tak mi się utrwaliło z języka C, że nie jest to dobrą praktyką :D
Hispano-Suiza
  • Rejestracja:ponad 8 lat
  • Ostatnio:ponad 5 lat
0

Zdecydowanie opcja numer 1. To, że przechodzi to już pewnie jakaś specyfika tego co odpala kod na Codewars. Od biedy lokalnie kod bez średników też da się odpalać ale JS ma je w swojej składni więc należy używać.


"Trolling is a art"
Freja Draco
Freja Draco
  • Rejestracja:prawie 7 lat
  • Ostatnio:ponad 3 lata
  • Postów:3394
0

A taki zapis, jest de facto niepoprawny?

Kopiuj
if (name[0].toLowerCase() === 'r') return name + " plays banjo";
else                               return name + " does not play banjo";

bo działa i może po prostu wyglądać czytelniej.


edytowany 1x, ostatnio: Freja Draco
DE
  • Rejestracja:ponad 9 lat
  • Ostatnio:10 miesięcy
  • Postów:1788
0

A może:

Kopiuj
function areYouPlayingBanjo(name) {
  if (name[0].toLowerCase() === 'r') {
    return name + " plays banjo"
  }
  
  return name + " does not play banjo"
}
edytowany 2x, ostatnio: Desu
kult
  • Rejestracja:prawie 22 lata
  • Ostatnio:ponad rok
0

Chyba najbardziej popularnym Style Guide jest ten od Airbnb https://github.com/airbnb/javascript
Tu masz config do eslint https://www.npmjs.com/package/eslint-config-airbnb

Proponuję to zainstalować i nie kombinować jak jest lepiej/gorzej. (Ewentualnie wybrać inny guide np Standard, Google, Common etc.)

edytowany 1x, ostatnio: kult
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)