{"id":939,"date":"2009-01-30T15:10:08","date_gmt":"2009-01-30T20:10:08","guid":{"rendered":"http:\/\/cherrycoated.com\/wordpress\/?p=939"},"modified":"2009-01-30T15:10:08","modified_gmt":"2009-01-30T20:10:08","slug":"using-javadoc","status":"publish","type":"post","link":"https:\/\/www.webliminal.com\/webliminalblog\/teaching\/using-javadoc","title":{"rendered":"Using Javadoc"},"content":{"rendered":"<p><a href=\"http:\/\/webliminal.com\/images\/sidepics\/sp81.jpg\"><img decoding=\"async\" src=\"http:\/\/webliminal.com\/images\/sidepics\/cwdata\/sp81.jpg\" alt=\"Fountain, Montreal, Canada\" hspace=\"22\" align=\"left\" \/><\/a>I&#8217;m teaching a section of Object-oriented Analysis &amp; Design. We&#8217;re using java, and so we&#8217;re using Javadoc. Here are some links to which I refer my students.<\/p>\n<ul class=\"delicious\">\n<li>\n<div class=\"delicious-link\"><a href=\"http:\/\/java.sun.com\/j2se\/javadoc\/writingdoccomments\/\">How to Write Doc Comments for the Javadoc Tool<\/a><\/div>\n<div class=\"delicious-extended\">This document describes the style guide, tag and image conventions we use in documentation comments for Java programs written at Java Software, Sun Microsystems. It does not rehash related material covered elsewhere:\u00c2\u00a0\u00c2\u00a0For reference material on Javadoc tags, see the Javadoc reference pages.\u00c2\u00a0\u00c2\u00a0<\/p>\n<p>For the required semantic content of documentation comments, see Requirements for Writing Java API Specifications.<\/p><\/div>\n<div class=\"delicious-tags\">(tags:\u00c2\u00a0<a href=\"http:\/\/delicious.com\/ernestackermann\/reference\">reference<\/a>\u00c2\u00a0<a href=\"http:\/\/delicious.com\/ernestackermann\/javadoc\">javadoc<\/a>\u00c2\u00a0<a href=\"http:\/\/delicious.com\/ernestackermann\/documentation\">documentation<\/a>\u00c2\u00a0<a href=\"http:\/\/delicious.com\/ernestackermann\/standards\">standards<\/a>\u00c2\u00a0<a href=\"http:\/\/delicious.com\/ernestackermann\/Guidelines\">Guidelines<\/a><a href=\"http:\/\/delicious.com\/ernestackermann\/comments\">comments<\/a>\u00c2\u00a0<a href=\"http:\/\/delicious.com\/ernestackermann\/coding\">coding<\/a>)<\/div>\n<\/li>\n<li><a href=\"http:\/\/open.ncsu.edu\/se\/tutorials\/javadoc\/\">Javadoc\u00c2\u00a0<\/a>(tags:\u00c2\u00a0<a href=\"http:\/\/delicious.com\/ernestackermann\/tutorial\">tutorial<\/a>\u00c2\u00a0<a href=\"http:\/\/delicious.com\/ernestackermann\/javadoc\">javadoc<\/a>)\u00c2\u00a0<a href=\"http:\/\/www.ibm.com\/developerworks\/library\/j-jtp0821.html\"><\/a><\/li>\n<li><a href=\"http:\/\/www.ibm.com\/developerworks\/library\/j-jtp0821.html\">Java theory and practice: I have to document THAT?\u00c2\u00a0<\/a>&#8220;Integrated documentation a la Javadoc is both a benefit and a burden&#8221; (tags:\u00c2\u00a0<a href=\"http:\/\/del.icio.us\/ernestackermann\/javadoc\">javadoc<\/a>)<\/li>\n<\/ul>\n<!-- AddThis Advanced Settings generic via filter on the_content --><!-- AddThis Share Buttons generic via filter on the_content -->","protected":false},"excerpt":{"rendered":"<p>I&#8217;m teaching a section of Object-oriented Analysis &amp; Design. We&#8217;re using java, and so we&#8217;re using Javadoc. Here are some links to which I refer my students. How to Write Doc Comments for the Javadoc Tool This document describes the style guide, tag and image conventions we use in documentation comments for Java programs written [&hellip;]<!-- AddThis Advanced Settings generic via filter on get_the_excerpt --><!-- AddThis Share Buttons generic via filter on get_the_excerpt --><\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[12],"tags":[162],"class_list":["post-939","post","type-post","status-publish","format-standard","hentry","category-teaching","tag-javadoc"],"_links":{"self":[{"href":"https:\/\/www.webliminal.com\/webliminalblog\/wp-json\/wp\/v2\/posts\/939","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.webliminal.com\/webliminalblog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.webliminal.com\/webliminalblog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.webliminal.com\/webliminalblog\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/www.webliminal.com\/webliminalblog\/wp-json\/wp\/v2\/comments?post=939"}],"version-history":[{"count":0,"href":"https:\/\/www.webliminal.com\/webliminalblog\/wp-json\/wp\/v2\/posts\/939\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.webliminal.com\/webliminalblog\/wp-json\/wp\/v2\/media?parent=939"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.webliminal.com\/webliminalblog\/wp-json\/wp\/v2\/categories?post=939"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.webliminal.com\/webliminalblog\/wp-json\/wp\/v2\/tags?post=939"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}