Code review REST API

maghost
Posts: 99
Joined: Sun Mar 27, 2016 12:30 am

Post

Jest Doxygen który działa jako tako w PHP
User avatar
fracz
Posts: 2342
Joined: Fri Oct 28, 2016 10:56 pm
Location: Kraków
Has thanked: 4 times
Been thanked: 6 times

Post

Z doświadczenia wiem że praktycznie każda dokumentacja generowana z kodu jest byle jaka. No bo co w niej więcej widać niż w kodzie? Nic.

Oczywiście fajna by była dokumentacja "z prawdziwego zdarzenia", najlepiej oparta na przykładach. A póki co, read the source Luke ;)
https://blog.codinghorror.com/learn-to- ... urce-luke/
magx2
Posts: 417
Joined: Wed May 17, 2017 1:27 pm
Has thanked: 1 time
Been thanked: 1 time

Post

fracz wrote: Tue Aug 01, 2017 1:40 pm A póki co, read the source Luke ;)
Jakiś czas temu implementowałem klienta Supla API w Javie i powiem, że czytanie sourca tylko po to by dowiedzieć się pod jaki URL bić żeby dostać jakąś encję to katorga. Ja poradziłem sobie tak że czytałem źródła przykładowego klienta napisanego w PHP.

Co do dokumentacji generowanej z kodu - cała Java na tym stoi (javadoc) i całkiem dobrze się to sprawdza.
Supla ❤️ Open HAB - https://github.com/magx2/openhab-supla
User avatar
fracz
Posts: 2342
Joined: Fri Oct 28, 2016 10:56 pm
Location: Kraków
Has thanked: 4 times
Been thanked: 6 times

Post

W Javie jest prościej bo jest statycznie typowana i od razu można zawrzeć w takiej dokumentacji chociażby typy argumentów i format odpowiedzi. W PHP - wiadomo. Jeśli byłyby zadbane PHPDoce to tak, ale... nie są ;)
magx2
Posts: 417
Joined: Wed May 17, 2017 1:27 pm
Has thanked: 1 time
Been thanked: 1 time

Post

Hah no też racja.
Supla ❤️ Open HAB - https://github.com/magx2/openhab-supla

Return to “CLOUD”