{"id":2376,"date":"2010-09-20T23:03:09","date_gmt":"2010-09-21T02:03:09","guid":{"rendered":"http:\/\/www.viamais.net\/blog\/?p=2376"},"modified":"2010-09-20T23:03:09","modified_gmt":"2010-09-21T02:03:09","slug":"documentacao-de-codigo-e-realmente-importante","status":"publish","type":"post","link":"https:\/\/www.viamais.net\/blog\/documentacao-de-codigo-e-realmente-importante\/","title":{"rendered":"Documenta\u00e7\u00e3o de c\u00f3digo \u00e9 realmente importante?"},"content":{"rendered":"<p>[ad#texto]<br \/>\nCerta vez participando de uma palestra, o palestrando disse que \u00e9 besteira o <strong>desenvolvedor de software<\/strong> se preocupar em produzir e manter documenta\u00e7\u00e3o do seu <strong>c\u00f3digo-fonte<\/strong>.<\/p>\n<p>O mesmo alegava que o trabalho em manter e produzir toda a documenta\u00e7\u00e3o \u00e9 muito amplo e desnecess\u00e1rio se o desenvolvedor seguir os <strong>padr\u00f5es<\/strong> de <strong>desenvolvimento<\/strong> existentes para a sua plataforma, no caso era uma palestra sobre <strong>Java<\/strong>.<\/p>\n<p>Eu pensei muito a respeito, e a minha opini\u00e3o \u00e9 totalmente contr\u00e1ria a do palestrante.<\/p>\n<p>Em primeiro lugar, produzir e manter uma <strong>documenta\u00e7\u00e3o<\/strong> no padr\u00e3o <strong>Javadoc<\/strong>, que \u00e9 o padr\u00e3o adotado pelo <strong>Java<\/strong>, \u00e9 muito simples e com a ajuda de IDE\u00b4s como o <strong>Netbeans<\/strong> ou o <strong>Eclipse<\/strong> essa tarefa se torna t\u00e3o modesta que n\u00e3o o pouco tempo que \u201cperdemos\u201d \u00e9 totalmente recompensado (com lucros) nas futuras manuten\u00e7\u00f5es e <em>upgrades<\/em> do <strong>sistema<\/strong>.<\/p>\n<p>A alega\u00e7\u00e3o do palestrante de que c\u00f3digo-fonte bem produzido \u00e9 intelig\u00edvel para qualquer outro desenvolvedor n\u00e3o est\u00e1 errado, mas tamb\u00e9m n\u00e3o \u00e9 t\u00e3o simplista assim.<\/p>\n<p>Por mais purista que o <strong>desenvolvedor<\/strong> seja, eu nunca vi em mais de 10 anos um <strong>c\u00f3digo-fonte<\/strong> que fosse t\u00e3o intelig\u00edvel assim, padr\u00f5es auxiliam e evitam a famosa <strong>programa\u00e7\u00e3o McGuiver<\/strong> (aquela que com o bloco de notas e o <strong>Javac<\/strong> fazemos um ERP em dois dias), sempre existe a demanda de tempo e aprendizado sobre o novo <strong>c\u00f3digo-fonte<\/strong> que vamos alterar ou trocar, e esse tempo \u00e9 diminu\u00eddo caso o <strong>c\u00f3digo-fonte<\/strong> esteja documentado.<\/p>\n<p>Ent\u00e3o fa\u00e7a um bem para voc\u00ea e para os demais, documente o seu <strong>c\u00f3digo-fonte<\/strong> e vamos fazer do <strong>desenvolvimento de software<\/strong> um lugar mais feliz!<\/p>\n<p>Aproveitante, se algu\u00e9m algum dia encontrar um <strong>c\u00f3digo-fonte<\/strong> t\u00e3o perfeito\u00a0 como o citado pelo palestrante, por favor em envie, pois vou emoldurar e pendurar na parede do meu quarto.<\/p>\n<div id=\"_mcePaste\" style=\"position: absolute; left: -10000px; top: 0px; width: 1px; height: 1px; overflow: hidden;\">\n<p><!--[if gte mso 9]><xml> <w:WordDocument> <w:View>Normal<\/w:View> <w:Zoom>0<\/w:Zoom> <w:TrackMoves \/> <w:TrackFormatting \/> <w:HyphenationZone>21<\/w:HyphenationZone> <w:PunctuationKerning \/> <w:ValidateAgainstSchemas \/> <w:SaveIfXMLInvalid>false<\/w:SaveIfXMLInvalid> <w:IgnoreMixedContent>false<\/w:IgnoreMixedContent> <w:AlwaysShowPlaceholderText>false<\/w:AlwaysShowPlaceholderText> <w:DoNotPromoteQF \/> <w:LidThemeOther>PT-BR<\/w:LidThemeOther> <w:LidThemeAsian>X-NONE<\/w:LidThemeAsian> <w:LidThemeComplexScript>X-NONE<\/w:LidThemeComplexScript> <w:Compatibility> <w:BreakWrappedTables \/> <w:SnapToGridInCell \/> <w:WrapTextWithPunct \/> <w:UseAsianBreakRules \/> <w:DontGrowAutofit \/> <w:SplitPgBreakAndParaMark \/> <w:EnableOpenTypeKerning \/> <w:DontFlipMirrorIndents \/> <w:OverrideTableStyleHps \/> <w:UseFELayout \/> <\/w:Compatibility> <w:DoNotOptimizeForBrowser \/> <m:mathPr> <m:mathFont m:val=\"Cambria Math\" \/> <m:brkBin m:val=\"before\" \/> <m:brkBinSub m:val=\"&#45;-\" \/> <m:smallFrac m:val=\"off\" \/> <m:dispDef \/> <m:lMargin m:val=\"0\" \/> <m:rMargin m:val=\"0\" \/> <m:defJc m:val=\"centerGroup\" \/> <m:wrapIndent m:val=\"1440\" \/> <m:intLim m:val=\"subSup\" \/> <m:naryLim m:val=\"undOvr\" \/> <\/m:mathPr><\/w:WordDocument> <\/xml><![endif]--><!--[if gte mso 9]><xml> <w:LatentStyles DefLockedState=\"false\" DefUnhideWhenUsed=\"true\"   DefSemiHidden=\"true\" DefQFormat=\"false\" DefPriority=\"99\"   LatentStyleCount=\"267\"> <w:LsdException Locked=\"false\" Priority=\"1\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" QFormat=\"true\" Name=\"Normal\" \/> <w:LsdException Locked=\"false\" Priority=\"9\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" QFormat=\"true\" Name=\"heading 1\" \/> <w:LsdException Locked=\"false\" Priority=\"9\" QFormat=\"true\" Name=\"heading 2\" \/> <w:LsdException Locked=\"false\" Priority=\"9\" QFormat=\"true\" Name=\"heading 3\" \/> <w:LsdException Locked=\"false\" Priority=\"9\" QFormat=\"true\" Name=\"heading 4\" \/> <w:LsdException Locked=\"false\" Priority=\"9\" QFormat=\"true\" Name=\"heading 5\" \/> <w:LsdException Locked=\"false\" Priority=\"9\" QFormat=\"true\" Name=\"heading 6\" \/> <w:LsdException Locked=\"false\" Priority=\"9\" QFormat=\"true\" Name=\"heading 7\" \/> <w:LsdException Locked=\"false\" Priority=\"9\" QFormat=\"true\" Name=\"heading 8\" \/> <w:LsdException Locked=\"false\" Priority=\"9\" QFormat=\"true\" Name=\"heading 9\" \/> <w:LsdException Locked=\"false\" Priority=\"39\" Name=\"toc 1\" \/> <w:LsdException Locked=\"false\" Priority=\"39\" Name=\"toc 2\" \/> <w:LsdException Locked=\"false\" Priority=\"39\" Name=\"toc 3\" \/> <w:LsdException Locked=\"false\" Priority=\"39\" Name=\"toc 4\" \/> <w:LsdException Locked=\"false\" Priority=\"39\" Name=\"toc 5\" \/> <w:LsdException Locked=\"false\" Priority=\"39\" Name=\"toc 6\" \/> <w:LsdException Locked=\"false\" Priority=\"39\" Name=\"toc 7\" \/> <w:LsdException Locked=\"false\" Priority=\"39\" Name=\"toc 8\" \/> <w:LsdException Locked=\"false\" Priority=\"39\" Name=\"toc 9\" \/> <w:LsdException Locked=\"false\" Priority=\"35\" QFormat=\"true\" Name=\"caption\" \/> <w:LsdException Locked=\"false\" Priority=\"10\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" QFormat=\"true\" Name=\"Title\" \/> <w:LsdException Locked=\"false\" Priority=\"1\" Name=\"Default Paragraph Font\" \/> <w:LsdException Locked=\"false\" Priority=\"11\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" QFormat=\"true\" Name=\"Subtitle\" \/> <w:LsdException Locked=\"false\" Priority=\"22\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" QFormat=\"true\" Name=\"Strong\" \/> <w:LsdException Locked=\"false\" Priority=\"20\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" QFormat=\"true\" Name=\"Emphasis\" \/> <w:LsdException Locked=\"false\" Priority=\"59\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Table Grid\" \/> <w:LsdException Locked=\"false\" UnhideWhenUsed=\"false\" Name=\"Placeholder Text\" \/> <w:LsdException Locked=\"false\" Priority=\"1\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" QFormat=\"true\" Name=\"No Spacing\" \/> <w:LsdException Locked=\"false\" Priority=\"60\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Light Shading\" \/> <w:LsdException Locked=\"false\" Priority=\"61\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Light List\" \/> <w:LsdException Locked=\"false\" Priority=\"62\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Light Grid\" \/> <w:LsdException Locked=\"false\" Priority=\"63\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Shading 1\" \/> <w:LsdException Locked=\"false\" Priority=\"64\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Shading 2\" \/> <w:LsdException Locked=\"false\" Priority=\"65\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium List 1\" \/> <w:LsdException Locked=\"false\" Priority=\"66\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium List 2\" \/> <w:LsdException Locked=\"false\" Priority=\"67\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Grid 1\" \/> <w:LsdException Locked=\"false\" Priority=\"68\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Grid 2\" \/> <w:LsdException Locked=\"false\" Priority=\"69\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Grid 3\" \/> <w:LsdException Locked=\"false\" Priority=\"70\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Dark List\" \/> <w:LsdException Locked=\"false\" Priority=\"71\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Colorful Shading\" \/> <w:LsdException Locked=\"false\" Priority=\"72\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Colorful List\" \/> <w:LsdException Locked=\"false\" Priority=\"73\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Colorful Grid\" \/> <w:LsdException Locked=\"false\" Priority=\"60\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Light Shading Accent 1\" \/> <w:LsdException Locked=\"false\" Priority=\"61\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Light List Accent 1\" \/> <w:LsdException Locked=\"false\" Priority=\"62\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Light Grid Accent 1\" \/> <w:LsdException Locked=\"false\" Priority=\"63\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Shading 1 Accent 1\" \/> <w:LsdException Locked=\"false\" Priority=\"64\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Shading 2 Accent 1\" \/> <w:LsdException Locked=\"false\" Priority=\"65\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium List 1 Accent 1\" \/> <w:LsdException Locked=\"false\" UnhideWhenUsed=\"false\" Name=\"Revision\" \/> <w:LsdException Locked=\"false\" Priority=\"34\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" QFormat=\"true\" Name=\"List Paragraph\" \/> <w:LsdException Locked=\"false\" Priority=\"29\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" QFormat=\"true\" Name=\"Quote\" \/> <w:LsdException Locked=\"false\" Priority=\"30\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" QFormat=\"true\" Name=\"Intense Quote\" \/> <w:LsdException Locked=\"false\" Priority=\"66\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium List 2 Accent 1\" \/> <w:LsdException Locked=\"false\" Priority=\"67\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Grid 1 Accent 1\" \/> <w:LsdException Locked=\"false\" Priority=\"68\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Grid 2 Accent 1\" \/> <w:LsdException Locked=\"false\" Priority=\"69\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Grid 3 Accent 1\" \/> <w:LsdException Locked=\"false\" Priority=\"70\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Dark List Accent 1\" \/> <w:LsdException Locked=\"false\" Priority=\"71\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Colorful Shading Accent 1\" \/> <w:LsdException Locked=\"false\" Priority=\"72\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Colorful List Accent 1\" \/> <w:LsdException Locked=\"false\" Priority=\"73\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Colorful Grid Accent 1\" \/> <w:LsdException Locked=\"false\" Priority=\"60\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Light Shading Accent 2\" \/> <w:LsdException Locked=\"false\" Priority=\"61\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Light List Accent 2\" \/> <w:LsdException Locked=\"false\" Priority=\"62\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Light Grid Accent 2\" \/> <w:LsdException Locked=\"false\" Priority=\"63\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Shading 1 Accent 2\" \/> <w:LsdException Locked=\"false\" Priority=\"64\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Shading 2 Accent 2\" \/> <w:LsdException Locked=\"false\" Priority=\"65\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium List 1 Accent 2\" \/> <w:LsdException Locked=\"false\" Priority=\"66\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium List 2 Accent 2\" \/> <w:LsdException Locked=\"false\" Priority=\"67\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Grid 1 Accent 2\" \/> <w:LsdException Locked=\"false\" Priority=\"68\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Grid 2 Accent 2\" \/> <w:LsdException Locked=\"false\" Priority=\"69\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Grid 3 Accent 2\" \/> <w:LsdException Locked=\"false\" Priority=\"70\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Dark List Accent 2\" \/> <w:LsdException Locked=\"false\" Priority=\"71\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Colorful Shading Accent 2\" \/> <w:LsdException Locked=\"false\" Priority=\"72\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Colorful List Accent 2\" \/> <w:LsdException Locked=\"false\" Priority=\"73\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Colorful Grid Accent 2\" \/> <w:LsdException Locked=\"false\" Priority=\"60\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Light Shading Accent 3\" \/> <w:LsdException Locked=\"false\" Priority=\"61\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Light List Accent 3\" \/> <w:LsdException Locked=\"false\" Priority=\"62\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Light Grid Accent 3\" \/> <w:LsdException Locked=\"false\" Priority=\"63\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Shading 1 Accent 3\" \/> <w:LsdException Locked=\"false\" Priority=\"64\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Shading 2 Accent 3\" \/> <w:LsdException Locked=\"false\" Priority=\"65\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium List 1 Accent 3\" \/> <w:LsdException Locked=\"false\" Priority=\"66\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium List 2 Accent 3\" \/> <w:LsdException Locked=\"false\" Priority=\"67\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Grid 1 Accent 3\" \/> <w:LsdException Locked=\"false\" Priority=\"68\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Grid 2 Accent 3\" \/> <w:LsdException Locked=\"false\" Priority=\"69\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Grid 3 Accent 3\" \/> <w:LsdException Locked=\"false\" Priority=\"70\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Dark List Accent 3\" \/> <w:LsdException Locked=\"false\" Priority=\"71\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Colorful Shading Accent 3\" \/> <w:LsdException Locked=\"false\" Priority=\"72\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Colorful List Accent 3\" \/> <w:LsdException Locked=\"false\" Priority=\"73\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Colorful Grid Accent 3\" \/> <w:LsdException Locked=\"false\" Priority=\"60\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Light Shading Accent 4\" \/> <w:LsdException Locked=\"false\" Priority=\"61\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Light List Accent 4\" \/> <w:LsdException Locked=\"false\" Priority=\"62\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Light Grid Accent 4\" \/> <w:LsdException Locked=\"false\" Priority=\"63\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Shading 1 Accent 4\" \/> <w:LsdException Locked=\"false\" Priority=\"64\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Shading 2 Accent 4\" \/> <w:LsdException Locked=\"false\" Priority=\"65\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium List 1 Accent 4\" \/> <w:LsdException Locked=\"false\" Priority=\"66\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium List 2 Accent 4\" \/> <w:LsdException Locked=\"false\" Priority=\"67\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Grid 1 Accent 4\" \/> <w:LsdException Locked=\"false\" Priority=\"68\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Grid 2 Accent 4\" \/> <w:LsdException Locked=\"false\" Priority=\"69\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Grid 3 Accent 4\" \/> <w:LsdException Locked=\"false\" Priority=\"70\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Dark List Accent 4\" \/> <w:LsdException Locked=\"false\" Priority=\"71\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Colorful Shading Accent 4\" \/> <w:LsdException Locked=\"false\" Priority=\"72\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Colorful List Accent 4\" \/> <w:LsdException Locked=\"false\" Priority=\"73\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Colorful Grid Accent 4\" \/> <w:LsdException Locked=\"false\" Priority=\"60\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Light Shading Accent 5\" \/> <w:LsdException Locked=\"false\" Priority=\"61\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Light List Accent 5\" \/> <w:LsdException Locked=\"false\" Priority=\"62\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Light Grid Accent 5\" \/> <w:LsdException Locked=\"false\" Priority=\"63\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Shading 1 Accent 5\" \/> <w:LsdException Locked=\"false\" Priority=\"64\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Shading 2 Accent 5\" \/> <w:LsdException Locked=\"false\" Priority=\"65\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium List 1 Accent 5\" \/> <w:LsdException Locked=\"false\" Priority=\"66\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium List 2 Accent 5\" \/> <w:LsdException Locked=\"false\" Priority=\"67\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Grid 1 Accent 5\" \/> <w:LsdException Locked=\"false\" Priority=\"68\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Grid 2 Accent 5\" \/> <w:LsdException Locked=\"false\" Priority=\"69\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Grid 3 Accent 5\" \/> <w:LsdException Locked=\"false\" Priority=\"70\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Dark List Accent 5\" \/> <w:LsdException Locked=\"false\" Priority=\"71\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Colorful Shading Accent 5\" \/> <w:LsdException Locked=\"false\" Priority=\"72\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Colorful List Accent 5\" \/> <w:LsdException Locked=\"false\" Priority=\"73\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Colorful Grid Accent 5\" \/> <w:LsdException Locked=\"false\" Priority=\"60\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Light Shading Accent 6\" \/> <w:LsdException Locked=\"false\" Priority=\"61\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Light List Accent 6\" \/> <w:LsdException Locked=\"false\" Priority=\"62\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Light Grid Accent 6\" \/> <w:LsdException Locked=\"false\" Priority=\"63\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Shading 1 Accent 6\" \/> <w:LsdException Locked=\"false\" Priority=\"64\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Shading 2 Accent 6\" \/> <w:LsdException Locked=\"false\" Priority=\"65\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium List 1 Accent 6\" \/> <w:LsdException Locked=\"false\" Priority=\"66\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium List 2 Accent 6\" \/> <w:LsdException Locked=\"false\" Priority=\"67\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Grid 1 Accent 6\" \/> <w:LsdException Locked=\"false\" Priority=\"68\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Grid 2 Accent 6\" \/> <w:LsdException Locked=\"false\" Priority=\"69\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Medium Grid 3 Accent 6\" \/> <w:LsdException Locked=\"false\" Priority=\"70\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Dark List Accent 6\" \/> <w:LsdException Locked=\"false\" Priority=\"71\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Colorful Shading Accent 6\" \/> <w:LsdException Locked=\"false\" Priority=\"72\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Colorful List Accent 6\" \/> <w:LsdException Locked=\"false\" Priority=\"73\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" Name=\"Colorful Grid Accent 6\" \/> <w:LsdException Locked=\"false\" Priority=\"19\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" QFormat=\"true\" Name=\"Subtle Emphasis\" \/> <w:LsdException Locked=\"false\" Priority=\"21\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" QFormat=\"true\" Name=\"Intense Emphasis\" \/> <w:LsdException Locked=\"false\" Priority=\"31\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" QFormat=\"true\" Name=\"Subtle Reference\" \/> <w:LsdException Locked=\"false\" Priority=\"32\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" QFormat=\"true\" Name=\"Intense Reference\" \/> <w:LsdException Locked=\"false\" Priority=\"33\" SemiHidden=\"false\"    UnhideWhenUsed=\"false\" QFormat=\"true\" Name=\"Book Title\" \/> <w:LsdException Locked=\"false\" Priority=\"37\" Name=\"Bibliography\" \/> <w:LsdException Locked=\"false\" Priority=\"39\" QFormat=\"true\" Name=\"TOC Heading\" \/> <\/w:LatentStyles> <\/xml><![endif]--><!--[if gte mso 10]> <mce:style><!   \/* Style Definitions *\/  table.MsoNormalTable \t{mso-style-name:\"Tabela normal\"; \tmso-tstyle-rowband-size:0; \tmso-tstyle-colband-size:0; \tmso-style-noshow:yes; \tmso-style-priority:99; \tmso-style-parent:\"\"; \tmso-padding-alt:0cm 5.4pt 0cm 5.4pt; \tmso-para-margin-top:0cm; \tmso-para-margin-right:0cm; \tmso-para-margin-bottom:10.0pt; \tmso-para-margin-left:0cm; \tmso-pagination:widow-orphan; \tfont-size:11.0pt; \tmso-bidi-font-size:10.0pt; \tfont-family:\"Calibri\",\"sans-serif\"; \tmso-ascii-font-family:Calibri; \tmso-ascii-theme-font:minor-latin; \tmso-hansi-font-family:Calibri; \tmso-hansi-theme-font:minor-latin; \tmso-bidi-font-family:\"Times New Roman\"; \tmso-bidi-theme-font:minor-bidi;} --> <!--[endif]--><\/p>\n<p class=\"MsoNormal\">Certa vez participando de uma palestra, o palestrando disse que \u00e9 besteira o <strong>desenvolvedor de software<\/strong> se preocupar em produzir e manter documenta\u00e7\u00e3o do seu <strong>c\u00f3digo-fonte<\/strong>.<\/p>\n<p class=\"MsoNormal\">O mesmo alegava que o trabalho em manter e produzir toda a documenta\u00e7\u00e3o \u00e9 muito amplo e desnecess\u00e1rio se o desenvolvedor seguir os <strong>padr\u00f5es<\/strong> de <strong>desenvolvimento<\/strong> existentes para a sua plataforma, no caso era uma palestra sobre <strong>Java<\/strong>.<\/p>\n<p class=\"MsoNormal\">Eu pensei muito a respeito, e a minha opini\u00e3o \u00e9 totalmente contr\u00e1ria a do palestrante.<\/p>\n<p class=\"MsoNormal\">Em primeiro lugar, produzir e manter uma <strong>documenta\u00e7\u00e3o<\/strong> no padr\u00e3o <strong>Javadoc<\/strong>, que \u00e9 o padr\u00e3o adotado pelo <strong>Java<\/strong>, \u00e9 muito simples e com a ajuda de IDE\u00b4s como o <strong>Netbeans<\/strong> ou o <strong>Eclipse<\/strong> essa tarefa se torna t\u00e3o modesta que n\u00e3o o pouco tempo que \u201cperdemos\u201d \u00e9 totalmente recompensado (com lucros) nas futuras manuten\u00e7\u00f5es e <em>upgrades<\/em> do <strong>sistema<\/strong>.<\/p>\n<p class=\"MsoNormal\">A alega\u00e7\u00e3o do palestrante de que c\u00f3digo-fonte bem produzido \u00e9 intelig\u00edvel para qualquer outro desenvolvedor n\u00e3o est\u00e1 errado, mas tamb\u00e9m n\u00e3o \u00e9 t\u00e3o simplista assim.<\/p>\n<p class=\"MsoNormal\">Por mais purista que o <strong>desenvolvedor<\/strong> seja, eu nunca vi em mais de 1<\/p>\n<p>Certa vez participando de uma palestra, o palestrando disse que \u00e9 besteira o <strong>desenvolvedor de software<\/strong> se preocupar em produzir e manter documenta\u00e7\u00e3o do seu <strong>c\u00f3digo-fonte<\/strong>.<\/p>\n<p>O mesmo alegava que o trabalho em manter e produzir toda a documenta\u00e7\u00e3o \u00e9 muito amplo e desnecess\u00e1rio se o desenvolvedor seguir os <strong>padr\u00f5es<\/strong> de <strong>desenvolvimento<\/strong> existentes para a sua plataforma, no caso era uma palestra sobre <strong>Java<\/strong>.<\/p>\n<p>Eu pensei muito a respeito, e a minha opini\u00e3o \u00e9 totalmente contr\u00e1ria a do palestrante.<\/p>\n<p>Em primeiro lugar, produzir e manter uma <strong>documenta\u00e7\u00e3o<\/strong> no padr\u00e3o <strong>Javadoc<\/strong>, que \u00e9 o padr\u00e3o adotado pelo <strong>Java<\/strong>, \u00e9 muito simples e com a ajuda de IDE\u00b4s como o <strong>Netbeans<\/strong> ou o <strong>Eclipse<\/strong> essa tarefa se torna t\u00e3o modesta que n\u00e3o o pouco tempo que \u201cperdemos\u201d \u00e9 totalmente recompensado (com lucros) nas futuras manuten\u00e7\u00f5es e <em>upgrades<\/em> do <strong>sistema<\/strong>.<\/p>\n<p>A alega\u00e7\u00e3o do palestrante de que c\u00f3digo-fonte bem produzido \u00e9 intelig\u00edvel para qualquer outro desenvolvedor n\u00e3o est\u00e1 errado, mas tamb\u00e9m n\u00e3o \u00e9 t\u00e3o simplista assim.<\/p>\n<p>Por mais purista que o <strong>desenvolvedor<\/strong> seja, eu nunca vi em mais de 10 anos um <strong>c\u00f3digo-fonte<\/strong> que fosse t\u00e3o intelig\u00edvel assim, padr\u00f5es auxiliam e evitam a famosa <strong>programa\u00e7\u00e3o McGuiver<\/strong> (aquela que com o bloco de notas e o <strong>Javac<\/strong> fazemos um ERP em dois dias), sempre existe a demanda de tempo e aprendizado sobre o novo <strong>c\u00f3digo-fonte<\/strong> que vamos alterar ou trocar, e esse tempo \u00e9 diminu\u00eddo caso o <strong>c\u00f3digo-fonte<\/strong> esteja documentado.<\/p>\n<p>Ent\u00e3o fa\u00e7a um bem para voc\u00ea e para os demais, documente o seu <strong>c\u00f3digo-fonte<\/strong> e vamos fazer do <strong>desenvolvimento de software<\/strong> um lugar mais feliz!<\/p>\n<p>Aproveitante, se algu\u00e9m algum dia encontrar um <strong>c\u00f3digo-fonte<\/strong> t\u00e3o perfeito\u00a0 como o citado pelo palestrante, por favor em envie, pois vou emoldurar e pendurar na parede do meu quarto.<\/p>\n<p class=\"MsoNormal\">0 anos um <strong>c\u00f3digo-fonte<\/strong> que fosse t\u00e3o intelig\u00edvel assim, padr\u00f5es auxiliam e evitam a famosa <strong>programa\u00e7\u00e3o McGuiver<\/strong> (aquela que com o bloco de notas e o <strong>Javac<\/strong> fazemos um ERP em dois dias), sempre existe a demanda de tempo e aprendizado sobre o novo <strong>c\u00f3digo-fonte<\/strong> que vamos alterar ou trocar, e esse tempo \u00e9 diminu\u00eddo caso o <strong>c\u00f3digo-fonte<\/strong> esteja documentado.<\/p>\n<p class=\"MsoNormal\">Ent\u00e3o fa\u00e7a um bem para voc\u00ea e para os demais, documente o seu <strong>c\u00f3digo-fonte<\/strong> e vamos fazer do <strong>desenvolvimento de software<\/strong> um lugar mais feliz!<\/p>\n<p class=\"MsoNormal\">Aproveitante, se algu\u00e9m algum dia encontrar um <strong>c\u00f3digo-fonte<\/strong> t\u00e3o perfeito<span> <\/span>como o citado pelo palestrante, por favor em envie, pois vou emoldurar e pendurar na parede do meu quarto.<\/p>\n<\/div>\n","protected":false},"excerpt":{"rendered":"<p>[ad#texto] Certa vez participando de uma palestra, o palestrando disse que \u00e9 besteira o desenvolvedor<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"jetpack_post_was_ever_published":false,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":false,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2}},"categories":[4,6],"tags":[66,67,33],"class_list":["post-2376","post","type-post","status-publish","format-standard","hentry","category-diversos","category-java","tag-diversos","tag-java","tag-netbeans"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v27.4 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>Documenta\u00e7\u00e3o de c\u00f3digo \u00e9 realmente importante? -<\/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:\/\/www.viamais.net\/blog\/documentacao-de-codigo-e-realmente-importante\/\" \/>\n<meta property=\"og:locale\" content=\"pt_BR\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Documenta\u00e7\u00e3o de c\u00f3digo \u00e9 realmente importante? -\" \/>\n<meta property=\"og:description\" content=\"[ad#texto] Certa vez participando de uma palestra, o palestrando disse que \u00e9 besteira o desenvolvedor\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.viamais.net\/blog\/documentacao-de-codigo-e-realmente-importante\/\" \/>\n<meta property=\"og:site_name\" content=\"ViamaisBLOG\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/viamais.viablog\" \/>\n<meta property=\"article:author\" content=\"https:\/\/www.facebook.com\/viamais.viablog\" \/>\n<meta property=\"article:published_time\" content=\"2010-09-21T02:03:09+00:00\" \/>\n<meta name=\"author\" content=\"Petter Rafael\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@petterrafael\" \/>\n<meta name=\"twitter:site\" content=\"@petterrafael\" \/>\n<meta name=\"twitter:label1\" content=\"Escrito por\" \/>\n\t<meta name=\"twitter:data1\" content=\"Petter Rafael\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. tempo de leitura\" \/>\n\t<meta name=\"twitter:data2\" content=\"5 minutos\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\\\/\\\/www.viamais.net\\\/blog\\\/documentacao-de-codigo-e-realmente-importante\\\/#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/www.viamais.net\\\/blog\\\/documentacao-de-codigo-e-realmente-importante\\\/\"},\"author\":{\"name\":\"Petter Rafael\",\"@id\":\"https:\\\/\\\/www.viamais.net\\\/blog\\\/#\\\/schema\\\/person\\\/a13697c83eb9e9fe998636b42c020ec2\"},\"headline\":\"Documenta\u00e7\u00e3o de c\u00f3digo \u00e9 realmente importante?\",\"datePublished\":\"2010-09-21T02:03:09+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/www.viamais.net\\\/blog\\\/documentacao-de-codigo-e-realmente-importante\\\/\"},\"wordCount\":951,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\\\/\\\/www.viamais.net\\\/blog\\\/#organization\"},\"keywords\":[\"Diversos\",\"Java\",\"Netbeans\"],\"articleSection\":[\"Diversos\",\"Java\"],\"inLanguage\":\"pt-BR\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\\\/\\\/www.viamais.net\\\/blog\\\/documentacao-de-codigo-e-realmente-importante\\\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/www.viamais.net\\\/blog\\\/documentacao-de-codigo-e-realmente-importante\\\/\",\"url\":\"https:\\\/\\\/www.viamais.net\\\/blog\\\/documentacao-de-codigo-e-realmente-importante\\\/\",\"name\":\"Documenta\u00e7\u00e3o de c\u00f3digo \u00e9 realmente importante? -\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/www.viamais.net\\\/blog\\\/#website\"},\"datePublished\":\"2010-09-21T02:03:09+00:00\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/www.viamais.net\\\/blog\\\/documentacao-de-codigo-e-realmente-importante\\\/#breadcrumb\"},\"inLanguage\":\"pt-BR\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/www.viamais.net\\\/blog\\\/documentacao-de-codigo-e-realmente-importante\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/www.viamais.net\\\/blog\\\/documentacao-de-codigo-e-realmente-importante\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"In\u00edcio\",\"item\":\"https:\\\/\\\/www.viamais.net\\\/blog\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Diversos\",\"item\":\"https:\\\/\\\/www.viamais.net\\\/blog\\\/category\\\/diversos\\\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Documenta\u00e7\u00e3o de c\u00f3digo \u00e9 realmente importante?\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/www.viamais.net\\\/blog\\\/#website\",\"url\":\"https:\\\/\\\/www.viamais.net\\\/blog\\\/\",\"name\":\"ViamaisBLOG\",\"description\":\"Blog de tecnologia com dicas para melhorar sua internet e as novidades de gadgets e aplicativos.\",\"publisher\":{\"@id\":\"https:\\\/\\\/www.viamais.net\\\/blog\\\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/www.viamais.net\\\/blog\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"pt-BR\"},{\"@type\":\"Organization\",\"@id\":\"https:\\\/\\\/www.viamais.net\\\/blog\\\/#organization\",\"name\":\"Viablog\",\"url\":\"https:\\\/\\\/www.viamais.net\\\/blog\\\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"pt-BR\",\"@id\":\"https:\\\/\\\/www.viamais.net\\\/blog\\\/#\\\/schema\\\/logo\\\/image\\\/\",\"url\":\"https:\\\/\\\/i0.wp.com\\\/www.viamais.net\\\/blog\\\/wp-content\\\/uploads\\\/2014\\\/10\\\/logo_viamais.png?fit=150%2C150&ssl=1\",\"contentUrl\":\"https:\\\/\\\/i0.wp.com\\\/www.viamais.net\\\/blog\\\/wp-content\\\/uploads\\\/2014\\\/10\\\/logo_viamais.png?fit=150%2C150&ssl=1\",\"width\":150,\"height\":150,\"caption\":\"Viablog\"},\"image\":{\"@id\":\"https:\\\/\\\/www.viamais.net\\\/blog\\\/#\\\/schema\\\/logo\\\/image\\\/\"},\"sameAs\":[\"https:\\\/\\\/www.facebook.com\\\/viamais.viablog\",\"https:\\\/\\\/x.com\\\/petterrafael\"]},{\"@type\":\"Person\",\"@id\":\"https:\\\/\\\/www.viamais.net\\\/blog\\\/#\\\/schema\\\/person\\\/a13697c83eb9e9fe998636b42c020ec2\",\"name\":\"Petter Rafael\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"pt-BR\",\"@id\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/ec1d50795aefe5170d97a2816386714d30fce28bcb746631048cc673d70f8443?s=96&d=identicon&r=g\",\"url\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/ec1d50795aefe5170d97a2816386714d30fce28bcb746631048cc673d70f8443?s=96&d=identicon&r=g\",\"contentUrl\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/ec1d50795aefe5170d97a2816386714d30fce28bcb746631048cc673d70f8443?s=96&d=identicon&r=g\",\"caption\":\"Petter Rafael\"},\"description\":\"Desenvolvedor Web atua com as tecnologias Java e PHP apoiadas pelos bancos de dados Oracle e MySQL. Al\u00e9m dos ambientes de desenvolvimento acima possuiu amplo conhecimento em servidores Apache\\\/Tomcat, Photoshop, Arte &amp; Foto, Flash e mais uma dezena de ferramentas e tecnologias emergentes. Atualmente colabora com o Viablog escrevendo sobre programa\u00e7\u00e3o e tecnologia.\",\"sameAs\":[\"http:\\\/\\\/www.viamais.net\\\/blog\",\"https:\\\/\\\/www.facebook.com\\\/viamais.viablog\"],\"url\":\"https:\\\/\\\/www.viamais.net\\\/blog\\\/author\\\/petterrafael\\\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Documenta\u00e7\u00e3o de c\u00f3digo \u00e9 realmente importante? -","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:\/\/www.viamais.net\/blog\/documentacao-de-codigo-e-realmente-importante\/","og_locale":"pt_BR","og_type":"article","og_title":"Documenta\u00e7\u00e3o de c\u00f3digo \u00e9 realmente importante? -","og_description":"[ad#texto] Certa vez participando de uma palestra, o palestrando disse que \u00e9 besteira o desenvolvedor","og_url":"https:\/\/www.viamais.net\/blog\/documentacao-de-codigo-e-realmente-importante\/","og_site_name":"ViamaisBLOG","article_publisher":"https:\/\/www.facebook.com\/viamais.viablog","article_author":"https:\/\/www.facebook.com\/viamais.viablog","article_published_time":"2010-09-21T02:03:09+00:00","author":"Petter Rafael","twitter_card":"summary_large_image","twitter_creator":"@petterrafael","twitter_site":"@petterrafael","twitter_misc":{"Escrito por":"Petter Rafael","Est. tempo de leitura":"5 minutos"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/www.viamais.net\/blog\/documentacao-de-codigo-e-realmente-importante\/#article","isPartOf":{"@id":"https:\/\/www.viamais.net\/blog\/documentacao-de-codigo-e-realmente-importante\/"},"author":{"name":"Petter Rafael","@id":"https:\/\/www.viamais.net\/blog\/#\/schema\/person\/a13697c83eb9e9fe998636b42c020ec2"},"headline":"Documenta\u00e7\u00e3o de c\u00f3digo \u00e9 realmente importante?","datePublished":"2010-09-21T02:03:09+00:00","mainEntityOfPage":{"@id":"https:\/\/www.viamais.net\/blog\/documentacao-de-codigo-e-realmente-importante\/"},"wordCount":951,"commentCount":0,"publisher":{"@id":"https:\/\/www.viamais.net\/blog\/#organization"},"keywords":["Diversos","Java","Netbeans"],"articleSection":["Diversos","Java"],"inLanguage":"pt-BR","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/www.viamais.net\/blog\/documentacao-de-codigo-e-realmente-importante\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/www.viamais.net\/blog\/documentacao-de-codigo-e-realmente-importante\/","url":"https:\/\/www.viamais.net\/blog\/documentacao-de-codigo-e-realmente-importante\/","name":"Documenta\u00e7\u00e3o de c\u00f3digo \u00e9 realmente importante? -","isPartOf":{"@id":"https:\/\/www.viamais.net\/blog\/#website"},"datePublished":"2010-09-21T02:03:09+00:00","breadcrumb":{"@id":"https:\/\/www.viamais.net\/blog\/documentacao-de-codigo-e-realmente-importante\/#breadcrumb"},"inLanguage":"pt-BR","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.viamais.net\/blog\/documentacao-de-codigo-e-realmente-importante\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.viamais.net\/blog\/documentacao-de-codigo-e-realmente-importante\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"In\u00edcio","item":"https:\/\/www.viamais.net\/blog\/"},{"@type":"ListItem","position":2,"name":"Diversos","item":"https:\/\/www.viamais.net\/blog\/category\/diversos\/"},{"@type":"ListItem","position":3,"name":"Documenta\u00e7\u00e3o de c\u00f3digo \u00e9 realmente importante?"}]},{"@type":"WebSite","@id":"https:\/\/www.viamais.net\/blog\/#website","url":"https:\/\/www.viamais.net\/blog\/","name":"ViamaisBLOG","description":"Blog de tecnologia com dicas para melhorar sua internet e as novidades de gadgets e aplicativos.","publisher":{"@id":"https:\/\/www.viamais.net\/blog\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.viamais.net\/blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"pt-BR"},{"@type":"Organization","@id":"https:\/\/www.viamais.net\/blog\/#organization","name":"Viablog","url":"https:\/\/www.viamais.net\/blog\/","logo":{"@type":"ImageObject","inLanguage":"pt-BR","@id":"https:\/\/www.viamais.net\/blog\/#\/schema\/logo\/image\/","url":"https:\/\/i0.wp.com\/www.viamais.net\/blog\/wp-content\/uploads\/2014\/10\/logo_viamais.png?fit=150%2C150&ssl=1","contentUrl":"https:\/\/i0.wp.com\/www.viamais.net\/blog\/wp-content\/uploads\/2014\/10\/logo_viamais.png?fit=150%2C150&ssl=1","width":150,"height":150,"caption":"Viablog"},"image":{"@id":"https:\/\/www.viamais.net\/blog\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/viamais.viablog","https:\/\/x.com\/petterrafael"]},{"@type":"Person","@id":"https:\/\/www.viamais.net\/blog\/#\/schema\/person\/a13697c83eb9e9fe998636b42c020ec2","name":"Petter Rafael","image":{"@type":"ImageObject","inLanguage":"pt-BR","@id":"https:\/\/secure.gravatar.com\/avatar\/ec1d50795aefe5170d97a2816386714d30fce28bcb746631048cc673d70f8443?s=96&d=identicon&r=g","url":"https:\/\/secure.gravatar.com\/avatar\/ec1d50795aefe5170d97a2816386714d30fce28bcb746631048cc673d70f8443?s=96&d=identicon&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/ec1d50795aefe5170d97a2816386714d30fce28bcb746631048cc673d70f8443?s=96&d=identicon&r=g","caption":"Petter Rafael"},"description":"Desenvolvedor Web atua com as tecnologias Java e PHP apoiadas pelos bancos de dados Oracle e MySQL. Al\u00e9m dos ambientes de desenvolvimento acima possuiu amplo conhecimento em servidores Apache\/Tomcat, Photoshop, Arte &amp; Foto, Flash e mais uma dezena de ferramentas e tecnologias emergentes. Atualmente colabora com o Viablog escrevendo sobre programa\u00e7\u00e3o e tecnologia.","sameAs":["http:\/\/www.viamais.net\/blog","https:\/\/www.facebook.com\/viamais.viablog"],"url":"https:\/\/www.viamais.net\/blog\/author\/petterrafael\/"}]}},"jetpack_publicize_connections":[],"jetpack_featured_media_url":"","jetpack_shortlink":"https:\/\/wp.me\/p5Ih4c-Ck","jetpack-related-posts":[{"id":754,"url":"https:\/\/www.viamais.net\/blog\/netbeans\/","url_meta":{"origin":2376,"position":0},"title":"Netbeans","author":"matrix","date":"26\/01\/2009","format":false,"excerpt":"Muita gente pergunta qual a melhor IDE para o desenvolvimento Java e eu sempre recomendo o Netbeans, al\u00e9m dos recursos de incorporar projetos de outras IDE\u00b4s ele automatiza v\u00e1rios processos \"chatos\" do desenvolvimento de software e desse modo permite que o desenvolvedor centre toda a sua aten\u00e7\u00e3o no projeto em\u2026","rel":"","context":"Em &quot;Java&quot;","block_context":{"text":"Java","link":"https:\/\/www.viamais.net\/blog\/category\/java\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":247,"url":"https:\/\/www.viamais.net\/blog\/nova-versao-do-netbeans\/","url_meta":{"origin":2376,"position":1},"title":"Nova vers\u00e3o do Netbeans","author":"matrix","date":"30\/04\/2008","format":false,"excerpt":"Saiu por estes dias a nova vers\u00e3o do Netbeans (6.1), o esquema de vers\u00f5es para download \u00e9 a mesma da vers\u00e3o anterior. Podemos escolher entre a vers\u00e3o mais light at\u00e9 a mais completa passando por vers\u00f5es com v\u00e1rios recursos espec\u00edficos (C\/C++, Ruby, PHP, etc). O download da vers\u00e3o completa fica\u2026","rel":"","context":"Em &quot;Java&quot;","block_context":{"text":"Java","link":"https:\/\/www.viamais.net\/blog\/category\/java\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":1237,"url":"https:\/\/www.viamais.net\/blog\/o-que-tem-de-novo-no-netbeans-67\/","url_meta":{"origin":2376,"position":2},"title":"O que tem de novo no Netbeans 6.7","author":"Petter Rafael","date":"13\/07\/2009","format":false,"excerpt":"O Netbeans chega na vers\u00e3o 6.7 com algumas novidades bem interessantes: Suporte a Maven para cria\u00e7\u00e3o de plugins e servi\u00e7os Web; Integra\u00e7\u00e3o com projeto Kenai; Aperfei\u00e7oamento do PHP; Suporte a C++ para cria\u00e7\u00e3o de perfil, biblioteca Qt, refatora\u00e7\u00e3o de c\u00f3digo e expans\u00e3o de macro; Suporte a Java ME para projetos\u2026","rel":"","context":"Em &quot;Java&quot;","block_context":{"text":"Java","link":"https:\/\/www.viamais.net\/blog\/category\/java\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":136,"url":"https:\/\/www.viamais.net\/blog\/lancada-a-versao-6-do-netbeans\/","url_meta":{"origin":2376,"position":3},"title":"Lan\u00e7ada a vers\u00e3o 6 do Netbeans.","author":"Petter Rafael","date":"04\/12\/2007","format":false,"excerpt":"Foi lan\u00e7ada a vers\u00e3o 6 do Netbeans (IDE para desenvolvimento Java). Essa nova vers\u00e3o dentre muitas melhorias podemos destacar: Melhoria para a codifica\u00e7\u00e3o e manuten\u00e7\u00e3o de c\u00f3digo; Inclu\u00ed\u00addo run-time para Ruby On Rails; Simplifica\u00e7\u00e3o do processo de instala\u00e7\u00e3o e configura\u00e7\u00e3o; Melhoria das ferramentas de produtividade; Toda a infraestrutura da IDE\u2026","rel":"","context":"Em &quot;Diversos&quot;","block_context":{"text":"Diversos","link":"https:\/\/www.viamais.net\/blog\/category\/diversos\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":4436,"url":"https:\/\/www.viamais.net\/blog\/fazer-o-netbeans-compilar-seu-projeto-em-um-unico-arquivo-jar\/","url_meta":{"origin":2376,"position":4},"title":"Fazer o Netbeans compilar seu projeto em um \u00fanico arquivo .jar","author":"Petter Rafael","date":"19\/12\/2012","format":false,"excerpt":"[ad#texto] Para que prefere o Netbeans para desenvolver suas aplica\u00e7\u00f5es Java j\u00e1 deve ter notado que ao compilar seu projeto, caso utilize alguma biblioteca externa (geralmente em .jar) o Netbeans cria uma pasta lib com todas eles para voc\u00ea. Isto se torna interessante pois a manuten\u00e7\u00e3o de sua aplica\u00e7\u00e3o Java\u2026","rel":"","context":"Em &quot;Java&quot;","block_context":{"text":"Java","link":"https:\/\/www.viamais.net\/blog\/category\/java\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":2892,"url":"https:\/\/www.viamais.net\/blog\/desenvolvendo-para-android-preparando-o-ambiente\/","url_meta":{"origin":2376,"position":5},"title":"Desenvolvendo para Android &#8211; preparando o Ambiente","author":"Petter Rafael","date":"28\/06\/2011","format":false,"excerpt":"[ad#texto] Basicamente Android \u00e9 Java, ou seja, quem j\u00e1 conhece o desenvolvimento J2ME estar\u00e1 em casa, por\u00e9m \u00e9 preciso notar alguns detalhes. O primeiro \u00e9 que um aplicativo compilado para Android tem o bytecode diferente do bytecode padr\u00e3o de uma JVM Java, o Android utiliza a JVM Dalvik. Sabendo disso\u2026","rel":"","context":"Em &quot;Android&quot;","block_context":{"text":"Android","link":"https:\/\/www.viamais.net\/blog\/category\/android\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]}],"jetpack_sharing_enabled":true,"jetpack_likes_enabled":false,"_links":{"self":[{"href":"https:\/\/www.viamais.net\/blog\/wp-json\/wp\/v2\/posts\/2376","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.viamais.net\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.viamais.net\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.viamais.net\/blog\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/www.viamais.net\/blog\/wp-json\/wp\/v2\/comments?post=2376"}],"version-history":[{"count":0,"href":"https:\/\/www.viamais.net\/blog\/wp-json\/wp\/v2\/posts\/2376\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.viamais.net\/blog\/wp-json\/wp\/v2\/media?parent=2376"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.viamais.net\/blog\/wp-json\/wp\/v2\/categories?post=2376"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.viamais.net\/blog\/wp-json\/wp\/v2\/tags?post=2376"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}