Sun Doc Check Doclet

Em um projeto java, normalmente, usamos java doc para documentação de código/api. Algumas vezes os programadores mais preguiçosos não fazem esse papel e a documentação fica incompleta e em muitas vezes ela nem existe. Essa ferramenta da Sun Sun Doc Check Doclet Gera estatísticas sobre os fontes de um projeto java e assim podemos ver quantos artefatos,quais,como estão documentados. Assim podemos ter um controle e garantir uma boa documentação e o uso correto de java doc. Valhe a pena seguir o padrão de documentação java. Para usar a ferramenta é simples, só precisamos colocar o jar doccheck.jar no classpath e utilizando ant fazemos a geração, segue um script de exemplo.




<project name="Sundoccheck-test" default="all" basedir=".">

     <!-- This build file compiles the Doc Check source files,
       builds a library jar file, and runs a sample test.  
       This file was derived from build.xml in Sun's Doc Check 
       workspace. -->


     <!-- Create properties for 
     variables that are used more than once -->

     <property name="base.dir" value="." />
     <property name="src" value="${base.dir}/src" />
     <property name="build" value="${base.dir}/bin" />
     <property name="build.classes" 
          value="${build}/org/diegopacheco/sundoccheck/model" />
     <property name="pack.name"
          value="org.diegopacheco.sundoccheck.model" />
     <property name="gen" value="gen-statics" />
     <property name="gen.api" value="${gen}/javadoc" />
     <property name="gen.out" value="${gen}/statisticas" />
     <property name="doccheck.dir"
          value="${base.dir}/lib/doccheck.jar" />

     <!-- Target que chama todos os outros! -->
     <target name="all" depends="javadoc,generate-statictics" 
          description="Do all tasks's" />

     <!-- Target que gera as staticticas -->
     <target name="generate-statictics" depends="" 
description="Generate sample documents to be sure the doclet runs">
          <!-- Don't put sampleOut in build dir,
           as links from DocCheck.html would be broken -->
          <delete dir="${gen.out}" />
          <mkdir dir="${gen.out}" />
          <javadoc docletpath="${doccheck.dir}" 
               doclet="com.sun.tools.doclets.doccheck.DocCheck" 
               defaultexcludes="yes" destdir="${gen.out}" 
               packagenames="${pack.name}" 
               additionalparam="-classlist
                                  -docletID
                                  -title 'DocCheck Test Code' 
                                        ">
               <sourcepath>
                    <pathelement path="${src}" />
               </sourcepath>
               <packageset dir="${src}">
                    <include name="**/**" />
               </packageset>
          </javadoc>
     </target>

     <!-- Generate Javadoc -->
     <target name="javadoc" description="Generates the javadoc">
          <javadoc 
               bottom="Sun-DocCheck-test by Crom - Crom's Monutain's" 
               destdir="${gen.api}" 
               doctitle="Javadocs: Sun-DocCheck-test 1.0" 
               private="false" version="false" 
               windowtitle="Javadocs: Sun-DocCheck-test 1.0">
               <sourcepath>
                    <pathelement path="${src}" />
               </sourcepath>
               <packageset dir="${src}">
                    <include name="**/**" />
               </packageset>
          </javadoc>
     </target>

</project>


Abraços.

Popular posts from this blog

Telemetry and Microservices part2

Installing and Running ntop 2 on Amazon Linux OS

Fun with Apache Kafka