Jak czytelnie zapisać fragment kodu

Jak czytelnie zapisać fragment kodu
rafal612b
R6
rafal612b
R6
  • Rejestracja:ponad 10 lat
  • Ostatnio:około 9 lat
  • Postów:25
0

Pisze sobie użytkowników i mam dwa bloki tego samego kodu pod sobą co mnie drażni jakiś pomysł jak się tego pozbyć ?

Założenia są takie ze
strona.pl/profil/nick/ -> prowadzi do profilu
strona.pl/profil/ -> prowadzi do naszego profilu jeśli jesteśmy zalogowani

Kod uprościłem żeby każdy wiedział o co chodzi

Kopiuj
<?php

	public function query()
	{
		if( CzyWAdresieJestNick() )
		{
			$res = mysqli_query(...);
		}
		elseif( CzyZalogowany() )
		{
			$res = mysqli_query(...);
		}
		else
		{
			page404();
			return false;
		}
		
		if(mysqli_num_rows($res) == 0)//zle podany nick
		{
			page404();
			return false;
		}
		
		$this->container = mysqli_fetch_assoc($res);
		return true;

	}
	
?>

jak widać powtarza mi się blok

Kopiuj
		{
			page404();
			return false;
		}

przesadzam czy jednak wypadało by coś z tym zrobić ?

Z góry dzięki za wszelkie odpowiedzi.

Udostępnij
Kopiuj link do postu Kopiuj link do postu jako Markdown
Komentuj
dzek69
dzek69
dzek69
dzek69
Moderator
  • Rejestracja:ponad 18 lat
  • Ostatnio:2 dni
  • Lokalizacja:Rzeszów
1

Raczej przesadzasz. To tylko dwie linijki. Próba wymanipulowania tak, żeby tylko nie powtarzać tego zaciemniłaby czytelność kodu, a to jest najważniejsze (no chyba, że miałoby się dzięki temu wykonywać całą sekundę krócej, a kod prawdopodobnie nie musiałby być modyfikowany w przyszłości, to wtedy można by było sobie pozwolić na zmniejszenie czytelności).

PS. Ja osobiście nie strawiłbym klamry otwierającej w nowej linii, brak spacji przed nawiasem otwierającym w if i spacji pomiędzy nawiasami a warunkami w if :p
if (CzyWAdresieJestNick()) { jest dla mnie czytelniejsze :p

R6
Klamerki w nowej lini to przyzwyczajenie z domyslnych ustawień Visual Studio. Przyzwyczaiłem sie do takiego zapisu i jakoś zostało. Z spacjami masz racje :D
dzek69
Ja nie mówię, że to jedyne słuszne podejście, bo ile ludzi, tyle gustów, a to jak POWINIENEŚ robić to kwestia tego czy dany język ma oficjalne zalecenia oraz tego czy modyfikujesz/rozwijasz istniejący projekt (wtedy utrzymujesz styl identyczny jak istniejący) ;)
fourfour
A czemu tego mysqli się nie czepiłeś, co? :)
dzek69
Jak ktoś chce i umie używać bezpiecznie (tu brak przykładów) to niech se używa. Ja sam napisałem sobie wrapper na mysqli właśnie i z tego korzystam.
Udostępnij
Kopiuj link do postu Kopiuj link do postu jako Markdown
Komentuj
matoung
matoung
matoung
matoung
  • Rejestracja:około 10 lat
  • Ostatnio:ponad 7 lat
  • Postów:53
0

Dwie powtarzające się linie kodu nie są problemem. Gorzej jakby było więcej. Wtedy można użyć określonego edytora, który będzie chował/rozwijał dane linijki kodu (podobnie jak Eclipse SDK w Javie).

ŁF
Tragiczne rozwiązanie. Jak kod jest spieprzony, to nie ukrywa się go, tylko przepisuje.
Udostępnij
Kopiuj link do postu Kopiuj link do postu jako Markdown
Komentuj
kchteam
kchteam
kchteam
kchteam
  • Rejestracja:ponad 10 lat
  • Ostatnio:ponad 7 lat
  • Lokalizacja:Tychy
  • Postów:155
1

Jak już wcześniej wspomniano, uproszczenie dwóch linijek to lekki przerost formy nad treścią. Zakładam jednak, że to przykład lub kod, który będzie w przyszłości rozbudowywany. W takim przypadku najlepiej przenieść powtarzający się kod do osobnej metody. Wtedy Twój kod wyglądałby następująco:

Kopiuj
<?php
 
    public function query()
    {
        if( CzyWAdresieJestNick() )
        {
            $res = mysqli_query(...);
        }
        elseif( CzyZalogowany() )
        {
            $res = mysqli_query(...);
        }
        else
        {
           return $$this->obsluzBlad();
        }
 
        if(mysqli_num_rows($res) == 0)//zle podany nick
        {
            return $this->obsluzBlad();
        }
 
        $this->container = mysqli_fetch_assoc($res);
        return true;
 
    }
	
	private function obsluzBlad()
	{
		 page404();
         return false;
	}
 
?>

Zaletą takiego rozwiązania jest to, że jakąkolwiek przyszłą modyfikację kodu robisz tylko w tym miejscu.
Ponadto, jeżeli planujesz użycie tego kodu w innych klasach, to warto rozważyć przeniesienie go na przykład do osobnej klasy narzędziowej.

[Mirek]

Jeden zespół, tysiące możliwości!
Udostępnij
Kopiuj link do postu Kopiuj link do postu jako Markdown
Komentuj
lhp
lhp
lhp
lhp
  • Rejestracja:prawie 11 lat
  • Ostatnio:około 2 godziny
  • Postów:49
0

rozwiązanie, które ja preferuję, bez dodatkowych metod

Kopiuj
<?php
 
    public function query()
    {
        $res = null;

        if( CzyWAdresieJestNick() )
        {
            $res = mysqli_query(...);
        }
        elseif( CzyZalogowany() )
        {
            $res = mysqli_query(...);
        }
 
        if($res && mysqli_num_rows($res) === 1)
        {
            $this->container = mysqli_fetch_assoc($res);
            return true;
        }
 
        page404();
        return false;
 
    }
Udostępnij
Kopiuj link do postu Kopiuj link do postu jako Markdown
Komentuj
Treść
Podgląd
Kliknij, aby dodać treść...
Kliknij, aby dodać załącznik lub wklej ze schowka.
Instrukcja obsługi Markdown
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)