November 2012
Intermediate to advanced
888 pages
54h 46m
Polish
Content preview from Ruby. Receptury
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.
17.11. Tworzenie dokumentacji aplikacji
Problem
Chcemy stworzyć dokumentację interfejsu API dla naszej aplikacji. Najlepiej by było, gdyby cała dokumentacja była zapisana w tych samych plikach co kod źródłowy.
Rozwiązanie
Dobrą praktyką programistyczną jest poprzedzanie metod, klas i modułów komentarzami, które pozwalają czytelnikom zorientować się, czego dotyczą określone konstrukcje. W języku Ruby wprowadzono dodatkowe udogodnienie polegające na możliwości łatwego przekształcenia tych komentarzy na zbiór stron HTML, które składają się na dokumentację kodu. Jest to mechanizm podobny do JavaDoc dla języka Java, PyDoc dla Pythona i Pod dla Perla.
Oto prosty przykład. Załóżmy, że aplikacja zawiera tylko jeden plik — sum.rb, w którym ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access
More than 5,000 organizations count on O’Reilly
O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.Julian F.
I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.Addison B.
I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.Amir M.
I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.