{"id":7304,"date":"2022-09-08T00:45:41","date_gmt":"2022-09-07T19:15:41","guid":{"rendered":"https:\/\/jassweb.com\/solved\/solved-how-to-make-a-javadoc-of-my-program\/"},"modified":"2022-09-08T00:45:41","modified_gmt":"2022-09-07T19:15:41","slug":"solved-how-to-make-a-javadoc-of-my-program","status":"publish","type":"post","link":"https:\/\/jassweb.com\/solved\/solved-how-to-make-a-javadoc-of-my-program\/","title":{"rendered":"[Solved] How to make a JAVADOC of my program?"},"content":{"rendered":"<p> [ad_1]<br \/>\n<\/p>\n<div id=\"answer-47860842\" class=\"answer js-answer accepted-answer js-accepted-answer\" data-answerid=\"47860842\" data-parentid=\"47860589\" data-score=\"3\" data-position-on-page=\"1\" data-highest-scored=\"1\" data-question-has-accepted-highest-score=\"1\" itemprop=\"acceptedAnswer\" itemscope itemtype=\"https:\/\/schema.org\/Answer\">\n<div class=\"post-layout\">\n<div class=\"votecell post-layout--left\"><\/div>\n<div class=\"answercell post-layout--right\">\n<div class=\"s-prose js-post-body\" itemprop=\"text\">\n<p>Javadoc is a kind of comment that you use in your program, to organize it, to make the program more friendly and to create a page HTML with everything you commented, like this:<br \/>\n<a rel=\"nofollow noopener\" target=\"_blank\" href=\"https:\/\/jassweb.com\/solved\/wp-content\/uploads\/2022\/09\/Solved-How-to-make-a-JAVADOC-of-my-program.png\"><img decoding=\"async\" src=\"https:\/\/jassweb.com\/solved\/wp-content\/uploads\/2022\/09\/Solved-How-to-make-a-JAVADOC-of-my-program.png\" alt=\"javadoc page example\"><\/a><\/p>\n<p>So, to create a javadoc, you&#8217;ll have top put <code>\/**<\/code> in place of  <code>\/*<\/code>.<br \/>\nThere is types of commands that you need to know when you&#8217;re creating the javadoc.<\/p>\n<blockquote>\n<p>@author &#8211; who created the program<br \/>\n  <br \/>@throws &#8211; for exceptions<br \/>\n  <br \/>@param &#8211; the method parameters<br \/>\n  <br \/>@return &#8211; what the method returns<\/p>\n<\/blockquote>\n<p>So, your code with javadoc will be like this:<\/p>\n<pre><code>\/**\n  * @author IncredibleCoding\n  *\/\npublic class Client\n{\nprotected int cod;\nprotected String name;\n\n\/**\n  * instance the code passed\n  *\/\npublic void setCod(int cod) throws Exception\n{\n  if(cod==null)\n  throw new Exception(\"Invalid code!\");\n\n  this.cod = cod;\n}\n\n\/**\n  * @returns the code\n  *\/\npublic int getCod()\n{\n  return this.cod;\n}\n\n\/**\n  * instance the name passed\n  * @param name, that is the name passed\n  * @throws Exception, if the name is in invalid format\n  *\/\npublic void setName(String name) throws Exception\n{\n  if(name==null || name.equals(\"\")\n  throw new Exception(\"Invalid name!\");\n\n  this.name = name;\n}\n\n\/**\n  * @returns the name \n  *\/\npublic String getName()\n{\n  return this.name;\n}\n\n\/**\n  * the constructor\n  * @param cod, that is the code passed\n  * @param name, that is the name passed\n  *\/\npublic Client(int cod, String name) throws Exception\n{\n  this.setCod(cod);\n  this.setName(name);\n}\n\n\/**\n  * @param obj, that is the object that will be compared\n  * @returns true if the object is equal to this, false if the object isn't equal\n  *\/\npublic boolean equals(Object obj)\n{\n  if(this==obj)\n  return true;\n\n  if(obj==null)\n  return false;\n\n  if(!(obj instanceof Client))\n  return false;\n\n  Client client = (Client)obj;\n\n  if(this.cod!=client.cod)\n  return false;\n\n  if(this.name!=client.name)\n  return false;\n\n  return true;\n}\n\n\/**\n  * returns the formatted variable like String\n  *\/\npublic String toString()\n{\n  return \"Code: \" + this.cod + \"\\n\" +\n         \"Name: \" + this.name;\n}\n\n\/**\n  * returns the hashCode of a variable\n  *\/\npublic int hashCode()\n{\n  int ret = 444;\n\n  ret += ret*7 + new Integer (this.cod).hashCode();\n  ret += ret*7 + (this.name).hashCode();\n\n  return ret;\n}\n\n\/**\n  * clone the object\n  *\/\npublic Object clone()\n{\n  Client ret = null;\n\n  try\n  {\n     ret = new Client(this);\n  }\n  catch(Exception error)\n  {\n   \/\/ this is never null \n  }\n\n  return ret;\n}\n\n\/**\n  * \"copy\" the variables\n  * @param model, that is the object that will be copied\n  * @throws Exception, if the model is inexistent\n  *\/\npublic Client(Client model) throws Exception\n{\n  if(model==null)\n  throw new Exception(\"Inexistent model!\");\n\n  this.cod = model.cod;\n  this.name = model.name;\n}\n\n}\n<\/code><\/pre>\n<p>You should consider take a look in this ORACLE&#8217;s page, this will help you too: <br \/><a rel=\"nofollow noopener\" target=\"_blank\" href=\"https:\/\/docs.oracle.com\/javase\/8\/docs\/technotes\/tools\/windows\/javadoc.html\">https:\/\/docs.oracle.com\/javase\/8\/docs\/technotes\/tools\/windows\/javadoc.html<\/a><br \/>\n<\/p>\n<\/p><\/div>\n<div class=\"mt24\"><\/div>\n<\/div>\n<p>            <span class=\"d-none\" itemprop=\"commentCount\">0<\/span> <\/p><\/div>\n<\/div>\n<p>[ad_2]<\/p>\n<p>solved How to make a JAVADOC of my program? <\/p>\n","protected":false},"excerpt":{"rendered":"<p>[ad_1] Javadoc is a kind of comment that you use in your program, to organize it, to make the program more friendly and to create a page HTML with everything you commented, like this: So, to create a javadoc, you&#8217;ll have top put \/** in place of \/*. There is types of commands that you &#8230; <a title=\"[Solved] How to make a JAVADOC of my program?\" class=\"read-more\" href=\"https:\/\/jassweb.com\/solved\/solved-how-to-make-a-javadoc-of-my-program\/\" aria-label=\"More on [Solved] How to make a JAVADOC of my program?\">Read more<\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[320],"tags":[2032,323,2031],"class_list":["post-7304","post","type-post","status-publish","format-standard","hentry","category-solved","tag-dao","tag-java","tag-javadoc"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v26.5 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>[Solved] How to make a JAVADOC of my program? - JassWeb<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/jassweb.com\/solved\/solved-how-to-make-a-javadoc-of-my-program\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"[Solved] How to make a JAVADOC of my program? - JassWeb\" \/>\n<meta property=\"og:description\" content=\"[ad_1] Javadoc is a kind of comment that you use in your program, to organize it, to make the program more friendly and to create a page HTML with everything you commented, like this: So, to create a javadoc, you&#8217;ll have top put \/** in place of \/*. There is types of commands that you ... Read more\" \/>\n<meta property=\"og:url\" content=\"https:\/\/jassweb.com\/solved\/solved-how-to-make-a-javadoc-of-my-program\/\" \/>\n<meta property=\"og:site_name\" content=\"JassWeb\" \/>\n<meta property=\"article:published_time\" content=\"2022-09-07T19:15:41+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/jassweb.com\/solved\/wp-content\/uploads\/2022\/09\/Solved-How-to-make-a-JAVADOC-of-my-program.png\" \/>\n<meta name=\"author\" content=\"Kirat\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Kirat\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/jassweb.com\/solved\/solved-how-to-make-a-javadoc-of-my-program\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/jassweb.com\/solved\/solved-how-to-make-a-javadoc-of-my-program\/\"},\"author\":{\"name\":\"Kirat\",\"@id\":\"https:\/\/jassweb.com\/solved\/#\/schema\/person\/65c9c7b7958150c0dc8371fa35dd7c31\"},\"headline\":\"[Solved] How to make a JAVADOC of my program?\",\"datePublished\":\"2022-09-07T19:15:41+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/jassweb.com\/solved\/solved-how-to-make-a-javadoc-of-my-program\/\"},\"wordCount\":139,\"publisher\":{\"@id\":\"https:\/\/jassweb.com\/solved\/#organization\"},\"image\":{\"@id\":\"https:\/\/jassweb.com\/solved\/solved-how-to-make-a-javadoc-of-my-program\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/jassweb.com\/solved\/wp-content\/uploads\/2022\/09\/Solved-How-to-make-a-JAVADOC-of-my-program.png\",\"keywords\":[\"dao\",\"java\",\"javadoc\"],\"articleSection\":[\"Solved\"],\"inLanguage\":\"en-US\"},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/jassweb.com\/solved\/solved-how-to-make-a-javadoc-of-my-program\/\",\"url\":\"https:\/\/jassweb.com\/solved\/solved-how-to-make-a-javadoc-of-my-program\/\",\"name\":\"[Solved] How to make a JAVADOC of my program? - JassWeb\",\"isPartOf\":{\"@id\":\"https:\/\/jassweb.com\/solved\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/jassweb.com\/solved\/solved-how-to-make-a-javadoc-of-my-program\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/jassweb.com\/solved\/solved-how-to-make-a-javadoc-of-my-program\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/jassweb.com\/solved\/wp-content\/uploads\/2022\/09\/Solved-How-to-make-a-JAVADOC-of-my-program.png\",\"datePublished\":\"2022-09-07T19:15:41+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/jassweb.com\/solved\/solved-how-to-make-a-javadoc-of-my-program\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/jassweb.com\/solved\/solved-how-to-make-a-javadoc-of-my-program\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/jassweb.com\/solved\/solved-how-to-make-a-javadoc-of-my-program\/#primaryimage\",\"url\":\"https:\/\/jassweb.com\/solved\/wp-content\/uploads\/2022\/09\/Solved-How-to-make-a-JAVADOC-of-my-program.png\",\"contentUrl\":\"https:\/\/jassweb.com\/solved\/wp-content\/uploads\/2022\/09\/Solved-How-to-make-a-JAVADOC-of-my-program.png\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/jassweb.com\/solved\/solved-how-to-make-a-javadoc-of-my-program\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/jassweb.com\/solved\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"[Solved] How to make a JAVADOC of my program?\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/jassweb.com\/solved\/#website\",\"url\":\"https:\/\/jassweb.com\/solved\/\",\"name\":\"JassWeb\",\"description\":\"Build High-quality Websites\",\"publisher\":{\"@id\":\"https:\/\/jassweb.com\/solved\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/jassweb.com\/solved\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/jassweb.com\/solved\/#organization\",\"name\":\"Jass Web\",\"url\":\"https:\/\/jassweb.com\/solved\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/jassweb.com\/solved\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/jassweb.com\/wp-content\/uploads\/2021\/02\/jass-website-logo-1.png\",\"contentUrl\":\"https:\/\/jassweb.com\/wp-content\/uploads\/2021\/02\/jass-website-logo-1.png\",\"width\":693,\"height\":132,\"caption\":\"Jass Web\"},\"image\":{\"@id\":\"https:\/\/jassweb.com\/solved\/#\/schema\/logo\/image\/\"}},{\"@type\":\"Person\",\"@id\":\"https:\/\/jassweb.com\/solved\/#\/schema\/person\/65c9c7b7958150c0dc8371fa35dd7c31\",\"name\":\"Kirat\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/jassweb.com\/solved\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/jassweb.com\/solved\/wp-content\/litespeed\/avatar\/1261af3c9451399fa1336d28b98ea3bb.jpg?ver=1775193939\",\"contentUrl\":\"https:\/\/jassweb.com\/solved\/wp-content\/litespeed\/avatar\/1261af3c9451399fa1336d28b98ea3bb.jpg?ver=1775193939\",\"caption\":\"Kirat\"},\"sameAs\":[\"http:\/\/jassweb.com\"],\"url\":\"https:\/\/jassweb.com\/solved\/author\/jaspritsinghghumangmail-com\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"[Solved] How to make a JAVADOC of my program? - JassWeb","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/jassweb.com\/solved\/solved-how-to-make-a-javadoc-of-my-program\/","og_locale":"en_US","og_type":"article","og_title":"[Solved] How to make a JAVADOC of my program? - JassWeb","og_description":"[ad_1] Javadoc is a kind of comment that you use in your program, to organize it, to make the program more friendly and to create a page HTML with everything you commented, like this: So, to create a javadoc, you&#8217;ll have top put \/** in place of \/*. There is types of commands that you ... Read more","og_url":"https:\/\/jassweb.com\/solved\/solved-how-to-make-a-javadoc-of-my-program\/","og_site_name":"JassWeb","article_published_time":"2022-09-07T19:15:41+00:00","og_image":[{"url":"https:\/\/jassweb.com\/solved\/wp-content\/uploads\/2022\/09\/Solved-How-to-make-a-JAVADOC-of-my-program.png","type":"","width":"","height":""}],"author":"Kirat","twitter_card":"summary_large_image","twitter_misc":{"Written by":"Kirat","Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/jassweb.com\/solved\/solved-how-to-make-a-javadoc-of-my-program\/#article","isPartOf":{"@id":"https:\/\/jassweb.com\/solved\/solved-how-to-make-a-javadoc-of-my-program\/"},"author":{"name":"Kirat","@id":"https:\/\/jassweb.com\/solved\/#\/schema\/person\/65c9c7b7958150c0dc8371fa35dd7c31"},"headline":"[Solved] How to make a JAVADOC of my program?","datePublished":"2022-09-07T19:15:41+00:00","mainEntityOfPage":{"@id":"https:\/\/jassweb.com\/solved\/solved-how-to-make-a-javadoc-of-my-program\/"},"wordCount":139,"publisher":{"@id":"https:\/\/jassweb.com\/solved\/#organization"},"image":{"@id":"https:\/\/jassweb.com\/solved\/solved-how-to-make-a-javadoc-of-my-program\/#primaryimage"},"thumbnailUrl":"https:\/\/jassweb.com\/solved\/wp-content\/uploads\/2022\/09\/Solved-How-to-make-a-JAVADOC-of-my-program.png","keywords":["dao","java","javadoc"],"articleSection":["Solved"],"inLanguage":"en-US"},{"@type":"WebPage","@id":"https:\/\/jassweb.com\/solved\/solved-how-to-make-a-javadoc-of-my-program\/","url":"https:\/\/jassweb.com\/solved\/solved-how-to-make-a-javadoc-of-my-program\/","name":"[Solved] How to make a JAVADOC of my program? - JassWeb","isPartOf":{"@id":"https:\/\/jassweb.com\/solved\/#website"},"primaryImageOfPage":{"@id":"https:\/\/jassweb.com\/solved\/solved-how-to-make-a-javadoc-of-my-program\/#primaryimage"},"image":{"@id":"https:\/\/jassweb.com\/solved\/solved-how-to-make-a-javadoc-of-my-program\/#primaryimage"},"thumbnailUrl":"https:\/\/jassweb.com\/solved\/wp-content\/uploads\/2022\/09\/Solved-How-to-make-a-JAVADOC-of-my-program.png","datePublished":"2022-09-07T19:15:41+00:00","breadcrumb":{"@id":"https:\/\/jassweb.com\/solved\/solved-how-to-make-a-javadoc-of-my-program\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/jassweb.com\/solved\/solved-how-to-make-a-javadoc-of-my-program\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/jassweb.com\/solved\/solved-how-to-make-a-javadoc-of-my-program\/#primaryimage","url":"https:\/\/jassweb.com\/solved\/wp-content\/uploads\/2022\/09\/Solved-How-to-make-a-JAVADOC-of-my-program.png","contentUrl":"https:\/\/jassweb.com\/solved\/wp-content\/uploads\/2022\/09\/Solved-How-to-make-a-JAVADOC-of-my-program.png"},{"@type":"BreadcrumbList","@id":"https:\/\/jassweb.com\/solved\/solved-how-to-make-a-javadoc-of-my-program\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/jassweb.com\/solved\/"},{"@type":"ListItem","position":2,"name":"[Solved] How to make a JAVADOC of my program?"}]},{"@type":"WebSite","@id":"https:\/\/jassweb.com\/solved\/#website","url":"https:\/\/jassweb.com\/solved\/","name":"JassWeb","description":"Build High-quality Websites","publisher":{"@id":"https:\/\/jassweb.com\/solved\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/jassweb.com\/solved\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/jassweb.com\/solved\/#organization","name":"Jass Web","url":"https:\/\/jassweb.com\/solved\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/jassweb.com\/solved\/#\/schema\/logo\/image\/","url":"https:\/\/jassweb.com\/wp-content\/uploads\/2021\/02\/jass-website-logo-1.png","contentUrl":"https:\/\/jassweb.com\/wp-content\/uploads\/2021\/02\/jass-website-logo-1.png","width":693,"height":132,"caption":"Jass Web"},"image":{"@id":"https:\/\/jassweb.com\/solved\/#\/schema\/logo\/image\/"}},{"@type":"Person","@id":"https:\/\/jassweb.com\/solved\/#\/schema\/person\/65c9c7b7958150c0dc8371fa35dd7c31","name":"Kirat","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/jassweb.com\/solved\/#\/schema\/person\/image\/","url":"https:\/\/jassweb.com\/solved\/wp-content\/litespeed\/avatar\/1261af3c9451399fa1336d28b98ea3bb.jpg?ver=1775193939","contentUrl":"https:\/\/jassweb.com\/solved\/wp-content\/litespeed\/avatar\/1261af3c9451399fa1336d28b98ea3bb.jpg?ver=1775193939","caption":"Kirat"},"sameAs":["http:\/\/jassweb.com"],"url":"https:\/\/jassweb.com\/solved\/author\/jaspritsinghghumangmail-com\/"}]}},"_links":{"self":[{"href":"https:\/\/jassweb.com\/solved\/wp-json\/wp\/v2\/posts\/7304","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/jassweb.com\/solved\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/jassweb.com\/solved\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/jassweb.com\/solved\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/jassweb.com\/solved\/wp-json\/wp\/v2\/comments?post=7304"}],"version-history":[{"count":0,"href":"https:\/\/jassweb.com\/solved\/wp-json\/wp\/v2\/posts\/7304\/revisions"}],"wp:attachment":[{"href":"https:\/\/jassweb.com\/solved\/wp-json\/wp\/v2\/media?parent=7304"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/jassweb.com\/solved\/wp-json\/wp\/v2\/categories?post=7304"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/jassweb.com\/solved\/wp-json\/wp\/v2\/tags?post=7304"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}