Witaj Gościu! ( Zaloguj | Rejestruj )

Forum PHP.pl

> Struktura funkcji - nazewnictwo - zasada jednej operacji
jackraymund
post
Post #1





Grupa: Zarejestrowani
Postów: 217
Pomógł: 21
Dołączył: 10.06.2011
Skąd: Głogów

Ostrzeżenie: (0%)
-----


Witam,
walczę z nazewnictwem
  1. $companyId = $this->updateCompanySetToArrayAndGetId($matchedData['company']);//wywolanie
  2. public function updateCompanySetToArrayAndGetId($aCompanyName)
  3. {
  4. $isCompanyExistInArray = in_array($aCompanyName,$this->companyArray);
  5. if(!$isCompanyExistInArray)
  6. {
  7. $companyId = $this->sqlUpdater->updateCompanyAndGetId($aCompanyName);
  8. $this->companyArray[$companyId] = $aCompanyName;
  9. return $companyId;
  10. }
  11. else
  12. return array_search($aCompanyName,$this->companyArray);
  13. }

Z zasady, jedna funkcja, jedna operacja,ten kod jest okropny, lecz zarazem nazwa tej funkcji jest okropna(pomijając tą zasadę).
Natomiast załóżmy że chciałbym zrobić to na tej zasadzie i zrobić to w miarę optymalnie.(chodzi o to, aby nie wywołać funkcji z sqlUpdater, gdy rekord znajduje się aktualnie w tablicy).

Jestem otwarty na wszelakie pomysły.

Pozdrawiam
Go to the top of the page
+Quote Post
 
Start new topic
Odpowiedzi
NickOver
post
Post #2





Grupa: Zarejestrowani
Postów: 332
Pomógł: 10
Dołączył: 13.03.2014
Skąd: Bydgoszcz

Ostrzeżenie: (0%)
-----


Cytat(Pyton_000 @ 25.03.2015, 13:38:06 ) *
Od zawsze (IMG:style_emoticons/default/wink.gif)
@NickOver miał na myśli komentowanie kodu samego w sobie, nie komentarze dla funkcji czy klasy bo to oczywiście obowiązkowe.

Komentowanie kodu to tylko ukrycie fatalnie napisanego kodu. Skoro ktoś pisze komentarz to znaczy że kod który napisał jest nieczytelny i nie da się wywnioskować w 2s. co on robi.
Dodatkowo komentarze się przedawniają. Mało kto dba o ich aktualizację podczas zmiany kodu.
Dlatego trzeba pisać kod jasny i czytelny aby na podstawie nazwy metody wiedzieć co ona robi bez zagłębiania się w kod. Jesli tak nie jest - jest fatalnie.


Również czytałeś czysty kod?

@topic
Tak jak Python napisał nie chodziło mi o komentarze takie hmmm... Generalne lecz o komentarze typu ta metoda w tej linijce robi to i to. Jeśli musisz to pisać to kod jest napisany źle ponieważ nawet jeśli masz kod który już napisany nie będzie edytowany to i tak robi się problem jeśli osoba która go czyta nie zna języka w którym jest napisany.
@up @up1 @up2 i chyba @up3
Nie sądzicie że ten temat, dizał i całe forum nie jest najlepszym miejscem na obrzucanie się docinkami kto umie więcej a kto mniej?
Go to the top of the page
+Quote Post

Posty w temacie


Reply to this topicStart new topic
2 Użytkowników czyta ten temat (2 Gości i 0 Anonimowych użytkowników)
0 Zarejestrowanych:

 



RSS Aktualny czas: 26.12.2025 - 04:35