Showing posts from January, 2013

Write Doc Comments for the Javadoc Tool

Write Doc Comments for the Javadoc ToolJavadoc Home Page This document describes the style guide, tag and image conventions we use in documentation comments for Java programs written at Java Software, Oracle. It does not rehash related material covered elsewhere: For reference material on Javadoc tags, see the Javadoc reference pages.For the required semantic content of documentation comments, see Requirements for Writing Java API Specifications. ContentsIntroductionPrinciplesTerminologySource FilesWriting Doc CommentsFormat of a Doc CommentDoc Comment Checking ToolDescriptionsA Style GuideTag Conventions ( @tag)Documenting Default ConstructorsDocumenting Exceptions with @throws TagPackage-Level CommentsDocumenting Anonymous Inner ClassesIncluding ImagesExamples of Doc CommentsTroubleshooting Curly Quotes (Microsoft Word) IntroductionPrinciples At Java Software, we have several guidelines that might make our documentation comments different than those of third party developers. Our do…