WTF per minute - wyznacznik czystego kodu

WTF per minute - wyznacznik czystego kodu
Fi3rce
  • Rejestracja:ponad 10 lat
  • Ostatnio:ponad 9 lat
  • Postów:423
0

Witam, jestem poczatkujacym programista zajmujacym sie web dev. Mam juz jakies doswiadczenie, wiec czasami jak popatrze sie na jakis kod to mam ochote sie zlapac za glowe (wczoraj mialem watpliwa przyjemnosc ogladania kodu Hindusow, ktory swoj layout zrobili w oparciu o &nbsp; i <p>). Prawdopodobnie moj kod rowniez nie nalezy do najlepszych dlatego chcialbym to zmienic.

Przeczytalem ksiazke R.C.Martin's Clean Code, ale wciaz jestem glodny wiedzy. Jakie mam oczekiwania? Glownie interesuje mnie nie tyle sam kod co dobre praktyki w projektowaniu stron www. Posluze sie banalnym przykladem (moze nie koniecznie nawet on jest prawidlowy): Jak wstawiac ikony? Za pomoca znacznika <i> - tak jak praktykuje Bootstrap / Facebook - czy tez <span>, a moze :before / :after ?, menu nav powinno miec strukture nav > ul itd.

Nie chce zeby cos tylko dzialalo, ale zeby przede wszystkim ten kod byl solidny i zebym nie musial sie go wstydzic.


„Every Pro was once an amateur, every expert was once a beginner.”
edytowany 2x, ostatnio: Fi3rce
Madaoo
  • Rejestracja:ponad 12 lat
  • Ostatnio:ponad rok
  • Postów:490
2

"Chodzenie po wodzie i tworzenie oprogramowania wg specyfikacji są łatwe, o ile woda i specyfikacja są zamrożone" - Edward V. Berard
pylaochos
Tak swoją drogą, kazda z tych reguł została opisana w Clean Code które podał autor ;)
vpiotr
  • Rejestracja:ponad 13 lat
  • Ostatnio:prawie 3 lata
1

To o co pytasz to reguły dot. HTML-a który ma swoją specyfikę.

Zasady ogólne (częściowo wyżej wymienione) spisałem tutaj:
http://www.foundbit.com/pl/zasoby/programowanie/podstawy/articles/zasady-kodowania.html

Zasady dot. HTML-a:

  • ogólnie szukaj tematów pod hasłem "semantyczny HTML"
  • możesz dodać "reponsywny HTML" - to nie do końca to samo, ale znajdziesz tam info jak się robi dzisiaj strony

Formatowanie przez

Kopiuj
<p> i &nbsp;

stosuje się w wypadku dokumentów generowanych na podstawie czegoś. Nie jest to piękne, ale napisanie automatu który sformatuje tekst na HTML na poziomie "w miarę" nie jest proste. Przykład takiego narzędzia to wszelkie wtyczki i konwertery Markdown.

dzek69
Moderator
  • Rejestracja:ponad 18 lat
  • Ostatnio:około 2 godziny
  • Lokalizacja:Rzeszów
2

To, co dziś będzie wzorcem - za rok będzie antywzorcem - losowy przykład: http://www.paulirish.com/2010/the-protocol-relative-url/

Niech to nie wygląda jak kupa śmieci, niech będzie czytelne dla każdego - to wystarczy :)


LukeJL
  • Rejestracja:około 11 lat
  • Ostatnio:2 minuty
  • Postów:8398
0

Jak wstawiac ikony? Za pomoca znacznika <i > tak jak praktykuje Bootstrap

używanie i do ikon to nadużycie HTMLa, ale jak robisz na Bootstrapie to poświęcasz czystość kodu na rzecz szybkości tworzenia strony od zera do jakiegoś tam efektu. Możesz szkielet strony zrobić bardzo szybko (czasem chwilę, jak dużo copy-pastujesz, czy generujesz szkielet kodu z automatu). Takie strony mają być szybkie w tworzeniu* (biorąc pod uwagę również to, że szybko się tworzy responsywność) i mają być znośne wizualnie, a nie mają mieć czystego HTMLu, bo nie to jest priorytetem w przypadku Bootstrapa.

*chociaż wydaje mi się, że o ile Bootstrap jest szybki w tworzeniu, to już modyfikacje istniejącego kodu takie łatwe nie są, a to dlatego że w Bootstrapie wszystko jest wpisane w HTMLu, niesemantycznie, napaćkane jest tego HTMLa pod niebiosa itp. Jakoś nie mam dobrych doświadczeń z modyfikacją istniejących już stron pisanych na Bootstrapie.

: Jak wstawiac ikony?

zależy gdzie i jakie. Ja myslę, że ważniejsze jest, żeby je wstawiać we właściwym formacie (czyli wektorowym, dzięki temu niezależnie od wielkości ekranu czy zoomu będą wyglądać tak samo dobrze).


edytowany 5x, ostatnio: LukeJL
Fi3rce
  • Rejestracja:ponad 10 lat
  • Ostatnio:ponad 9 lat
  • Postów:423
0

Wielkie dzieki za pomocne posty :)


„Every Pro was once an amateur, every expert was once a beginner.”
hauleth
Moderator
  • Rejestracja:około 17 lat
  • Ostatnio:11 dni
0

Jeśli chodzi o wstawianie ikon to najodpowiedniejszy będzie znacznik <span> ale zawsze można stworzyć własny (HTML5 na to pozwala) <x-icon>. Było by to dość semantyczne i oddawało by sens, a sądzę, że czytniki ekranu poradziły by sobie z tym jeśli był by odpowiedni rel do tego podpięty.


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