Ta strona używa ciasteczek (cookies), dzięki którym nasz serwis może działać lepiej. Dowiedz się więcej OK, rozumiem

Czy istnieją jakieś standardy jak powinien wyglądać kod ?

Chcesz nauczyć się projektowania funkcjonalnych i dostępnych dla wszystkich serwisów, poznać standardy tworzenia stron WWW? A może masz w tej dziedzinie spore doświadczenie, ktorym chcesz się podzielić z innymi?

Czy istnieją jakieś standardy jak powinien wyglądać kod ?

Post 01.10.2017, 19:13:24

Hej. To moj pierwszy post na tym forum... szukalem na forum ale nie znalazlem tematu

Czy istnieją jakieś standardy żeby kod był przejrzysty/czytelny dla innego programisty ?

Macie może pomysły gdzie można o tym poczytać... może być inglisz werszyn...

Czy np CSS powinien wygladac tak i tak... a czesc body tak i tak...

pozdrawiam
Marcin
mzmartin
Posty: 1
Dołączył(a): 01.10.2017

Re: Czy istnieją jakieś standardy jak powinien wyglądać kod

Post 02.10.2017, 09:43:36

Dla CSS opracowano różne konwencje (głównie w notacjach selektorów, ale zdarzają się też reguły formatowania kodu), żadna z nich nie stała się tym jedynym obowiązującym standardem, więc warto się zapoznać z kilkoma i wybrać tę, która przyniesie najwięcej korzyści twojemu projektowi/zespołowi.

Poczytaj o BEM, OOCSS, SMACSS, ACSS, oCSS. http://clubmate.fi/oocss-acss-bem-smacs ... uld-i-use/
Dziękuję wszystkim za lata współpracy, ciekawych pytań i dyskusji. Będę wspominał to forum z wielkim sentymentem • kukawski.pl
Avatar użytkownikakuku
Rafał Kukawski

410 Gone
410 Gone

Posty: 19890
Dołączył(a): 14.04.2002

Re: Czy istnieją jakieś standardy jak powinien wyglądać kod

Post 14.12.2017, 14:48:22

Istnieją::

1. KISS
2. W3C
3. UDN (w PL nie honorowany)
pixelplus
Posty: 16
Dołączył(a): 10.09.2013

Re: Czy istnieją jakieś standardy jak powinien wyglądać kod

Post 15.12.2017, 05:18:01

Tak,istnieją. Po pierwsze czytelność. Jeśli robisz coś większego i spodziewasz się że inny programista zanurzy tam nos,warto dopilnować by bez problemu odnalazł klamry i nawiasy.
Komentarze nie powinny zlewać się z kodem, a już w szczególności wtedy gdy wyznaczają daną sekcję. Czy sobie komentujesz po polsku, czy po angielsku (zależnie od tego kto tam będzie zaglądał), oznacz rozpoczęcie i zakończenie danej sekcji kodu. Jak to zrobisz - twoja rzecz byle było logicznie i czytelnie.
/*========ROZPOCZĘCIE x ========*/
kod
/*========ZAKOŃCZENIE x ========*/
to całkiem ładny nawyk który po pierwsze tobie samemu uprości późniejszą modyfikację kodu, po drugie zaoszczędzi czas współtwórcom / innym programistom.

Zresztą jeśli zabieram się za pisanie czegoś większego, to najpierw rozpisuję sobie schemat, a później przygotowując plik zaczynam od podzielenia sekcji komentarzami. Tak po postu jest łatwiej i nie "dopisuje mi się" przypadkowa treść w przypadkowym miejscu, bo oto coś dodałam ;) Na tym etapie również staram się ustalić ile i jakich plików będzie wczytywanych w główne pliki projektu, i tworzę sobie czystą wersję takiej nowej podstrony. Znów gdy trzeba coś dodać, nie gdybam, nie uczę się od nowa schematu własnego projektu i po prostu dopisuję w wybranej sekcji wybrane linie. Oszczędzam czas swój i współautora jeśli takowy uczestniczy.

Jeśli chodzi o html i odsuwanie od krawędzi proporcjonalnie do zagnieżdżenia elementu, stawiaj na wygode, estetykę i logikę - bo nieraz przeglądając sprzedażowe templaty widziałam że tak dalece się tym przejęto, że body zaczynało się na środku monitora, nie mówiąc o zawartości. Ani to dobrze nie wygląda ani nie jest dla nikogo wygodne, ale za to jak bardzo pro :D Ja CSS'ów nie komentuję jeśli ma łącznie mniej niż 1000 linii, choć faktycznie staram się pilnować wizualnego porządku. Podobnie żaden znajomy tego nie robi. Chyba że to produkt sprzedażowy w którym klient będzie szperał.

Rzecz kolejna. Nie komentuj wszystkiego. Skoro masz w body sekcję header, nie pisze się że oto jest właśnie header, i ten header robi za nagłówek na górze strony. Nie ma sensu w css zamieszczać nad a:link informacji że oto jest link bo każdy wie że to nie kapusta. Dosyć zabawne są komentarze na początku pliku nad powiedzmy include 'conn.php' /*wczytujemy plik do polączenia z bazą*/ - bez komentarza z całą pewnością nikt by się tego nie domyślił :) echo $zmienna //Wyświetla $zmienną. No kto by przypuszczał? A niestety takie kfiatki widuje się dosyć często -zapewne zasugerowane pomocami z forów, gdzie faktycznie początkującym zostawia się tego typu komentarze, by właśnie wiedzieli że to nie kapusta.

Nie dziel plików przypadkowo. Uporządkuj je pod kątem funcjonalności bądź rejonów strony za które odpowiadają, ale nie na zasadzie "W tym pliku mam już dużo to część napiszę w innym". Wówczas ty będziesz wiedział o co chodzi, twój klient będzie wiedział o co chodzi,a jeśli akurat pojedziesz na Karaiby i utopisz tam telefon - zatrudniony programista też będzie wiedział o co chodzi :) A miałam już przypadek gdzie firma która stawiała stronę... nie była w stanie określić o co chodzi bo pracownik -autor skryptów akurat był na urlopie.

Zawsze włączaj zwracanie błędów (chyba że szukanie po 30 plikach niedoklepanej klamry to wyzwanie ambicjonalne), sprawdzaj działanie kodu na każdym określonym do zamknięcia etapie prac, wówczas oprogramowanie nie jest jak świątynia - gdzie najpierw budujesz, budujesz a później się modlisz.

Jeśli chodzi o optymalny css, prosta zasada mówi "im mniej tym lepiej". Przy możliwości łączenia klas nie ma sensu bawić się w 200 klas dla 200 przycisków, skoro można to zrobić 2 klasami. W ostateczności 4.

Czasem jeszcze w sieci widuje się relikty przeszłości jak żart "trudno było napisać, niech będzie trudno zrozumieć" ale w moim odczuciu to domena ludzi którzy boja się, że ktoś wykryje ich niedociągnięcia. Prawda jest taka że jeśli ktoś ma na tyle wiedzy by zrozumieć nasz kod, ma na tyle wiedzy by go samemu napisać.Doceńmy że sięgnął właśnie po nasz i nie wariujmy ;)

Ogólnie, nikt ci nie powie "Ej, stary, czemu ty masz wszysyko w 1 pliku css i nic tam nie importujesz?" albo "to takie głupie że przenosisz klamry do nowej linii" - takie rzeczy się nie dzieją ;) Jeśli ktoś za coś będzie miał pretensje to za kod nieczytelny, rozsiany po pliku(lub katalogach) przypadkowo.
Avatar użytkownikaLuna_s20
Posty: 98
Dołączył(a): 02.05.2014

Re: Czy istnieją jakieś standardy jak powinien wyglądać kod

Post 18.12.2017, 14:39:27

Przede wszystkim czytelność, żebyś Ty sam wiedział o co Ci chodzi. Oprócz tego stosuj dużo komentarzy, w razie jakbyś miał zapomnieć jak coś działa. Wcięcia są również bardzo pomocne ^^ To takie odemnie, ale są też "wytyczne" jak to robić profesjonalnie, jak nazywać klasy, zmienne itp. Z czasem samo to w Ciebie wejdzie ;)
kartky
Posty: 1
Dołączył(a): 18.12.2017


Powrót do Standardy sieciowe


 


  • Podobne wątki
    Odpowiedzi
    Wyświetlone
    Ostatni post

Kto przegląda forum

Użytkownicy przeglądający ten dział: Brak zidentyfikowanych użytkowników i 6 gości

Subskrypcja

Mamy 53896 zarejestrowanych użytkowników.
Najnowszy użytkownik: mandeischera


Nasi użytkownicy napisali:

  • 940495 wiadomości
  • w 249554 tematach

Najnowsze wpisy na blogu

Najnowsze artykuły

Najaktywniejsi (ostatnie 30 dni)