ITEM 56: WRITE DOC COMMENTS FOR ALL EXPOSED API ELEMENTS
257
The first “sentence” of each doc comment (as defined below) becomes the
summary description
of the element to which the comment pertains. For example,
the summary description in the doc comment on page 255 is “Returns the element
at the specified position in this list.” The summary description must stand on its
own to describe the functionality of the element it summarizes. To avoid confu-
sion,
Do'stlaringiz bilan baham: