Code review REST API

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

Tue Aug 01, 2017 1:37 pm

Jest Doxygen który działa jako tako w PHP
User avatar
fracz
Posts: 1583
Joined: Fri Oct 28, 2016 10:56 pm
Location: Rybna

Tue Aug 01, 2017 1:40 pm

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: 311
Joined: Wed May 17, 2017 1:27 pm
Contact:

Tue Aug 01, 2017 1:46 pm

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.
User avatar
fracz
Posts: 1583
Joined: Fri Oct 28, 2016 10:56 pm
Location: Rybna

Tue Aug 01, 2017 6:34 pm

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ą ;)
Post Reply