[markaron]

Jak nie nazywać metod i struktur swojego API na przykładzie API Poczty Polskiej

http://www.poczta-polska.pl/pliki/webservices/Metody%20i%20struktury%20uslugi%20sieciowej%20Poczty%20Polskiej%20SA.pdf?84cd58

Potem w kodzie wygląda to tak:

#humorinformatykow #programowanie #backend

[husky83]

@markaron: wczoraj miałem pierwszy raz z tym styczność - ale jak by nie patrzeć - większość z nas też tak robi ;-)

[marc1027]

@markaron: Co w tym dziwnego? Że użyto polskich nazw?

[K.....a]

@markaron: Aż przypomniała mi się Java #pdk ( ͡° ͜ʖ ͡°)

[markaron]

@marc1027: @husky83:

To są tzw dobre praktyki. Mieszanie nazw polskich i angielskich sprawia, że kod jest nieczytelny i może być niezrozumiały dla innych osób. Jeżeli ktoś klepie kod sam w piwnicy to niech sobie klepie jak chce. W poważnych firmach takie rzeczy są po prostu niedopuszczalne.

[markaron]

@KaszaGryczana: Tak na marginesie to API Poczty Polskiej jest właśnie pisane w Javie ( ͡° ͜ʖ ͡°)

Naprawdę w głowie mi się nie mieści jak tak duża i międzynarodowa firma jak PP tworzy API nazywając metody i struktury po polsku.

[devml]

Naprawdę w głowie mi się nie mieści jak tak duża i międzynarodowa firma jak PP tworzy API nazywając metody i struktury po polsku.

@markaron: API Comarch style
""Dowolny problem informatyczny można rozwiązać skończoną liczbą studentów"

[m.....d]

@markaron: chodzi o zachowanie ścisłości z terminologią biznesową Pocztu Polskiej a ta jest po polsku. Reszta kodu jest prawilnie po angielsku ( ͡° ͜ʖ ͡°)

[markaron]

@mandeo_weekend: Kolega z PP? ( ͡° ͜ʖ ͡°) Nie wydaje ci się, że tym podejściem możecie utrudniać integrację z waszym systemem niepolskojęzycznym programistom? Ja bym się wk** gdybym miał pisać klienta dla API napisanego po holendersku albo duńsku.

[m.....e]

@markaron: chciałbym pracować z kimś takim kto tak pisze kod :-)

[m.....d]

@markaron: nie programuję dla dla Poczty. Pracowałem na Poczcie 2000 ale jako użytkownik.

[C.....g]

@markaron: zatem do projektu będzie potrzeby polski programista - profit dla polski i kogoś od nas - nie martwię się o obce firmy

[devml]

@mandeo_weekend: najbardziej wali po oczach brak konsekwencji w stosowaniu nazw. Skoro terminologia biznesowa PP jest po polsku, to czemu w kodzie widnieje shipmentNumber?
Albo z jaką terminologią jest zwiazane sledzeniePortTypeClient - co to qwa wogole za twór?
Dodatkowo część nazw jest skracana wedle uznania autora.
Nie wiem, kto mogł taki kod przepuścić przez review, podejrzewam, że w programie dla prywatnego klienta by to nie przeszło.

[markaron]

@devml: Odpowiem za kolegę bo to raczej do mnie :)

Otóż kod jest mój. To co jest tworem PP to obiekty Przeylka, DanePrzesylki, SledzeniePortType i ich właściwości/pola. Shipment i ShipmentDetails to moje obiekty biznesowe.

Twór SledzeniePortTypeClient to obiekt wygenerowany przez .NET Framework jako obiekt proxy do ich serwisu. Gdyby nazwali go np. Tracking to wynikowym byłby obiekt TrackingPortTypeClient

Niestety pisząc kod po angielsku i korzystając z ich struktur

[markaron]

@micze: w sensie z PP? ( ͡° ͜ʖ ͡°)

[devml]

@markaron: ok, moja nieuwaga - przejżałem post na szybko i potraktowałem kod całościowo :)
Masz rację co do użycia polskiego w zewnetrznym api.

[Solpatium]

@markaron: Co to za IDE? :)

[repro5]

@markaron: Taaa programista sam nie wiedział, czy używać angielskich, czy polskich nazw, więc stworzył mix :)

[markaron]

@repro5: Jak pisałem wyżej kod jest mój. Mix powstał dlatego, że ja piszę po angielsku, a obiekty w API i ich właściwości są pisane po polsku. Pozwala to domniemywać, że kod za API też jest pisany po polsku ( ͡° ͜ʖ ͡°)

@Solpatium: Visual Studio 2015 po stuningowaniu dodatkiem Visual Studio 2015 Color Theme Editor ( ͡° ͜ʖ ͡°) i

[markaron]

@jednorazowkastowka: Jak napisałem wyżej pisanie kodu po angielsku jest po prostu dobrą i zalecaną praktyką.