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

C Unit Testing with Check

Image
When I start on IT, several years ago(+15), C was the first language that I learned. But was not the first language I mastered and deployed in production which was...surprisingly Visual Basic 6.0. However, when I learned C or any language back on that old and arcane time noddy was into testing. However now is impossible to work professionally in any language without tests. C is a low-level language but still kicks ass and has several interesting libs/frameworks. People use to fear C a lot because of lack of syntactical sugar but once you get used to it is not that hard at all. Today I want to show how you can do Unit Testing with C. I will not show how to do Unit Testing with C++ but with C ANSI actually. We will be using Check a unit test lib for C ANSI.
read more »

Having fun with Zig Language

Image
Zig is a general-purpose language created in 2016 by Andrew Kelly .  Zig aims to fix the issues C language has while being pragmatic and simple at the same time. Zig really shines as being simple by not having any hidden control flows, not having hidden memory allocations, no pre-processors, and no macros. Basically, it's one language and one language only. Since pre-processors and macros can get really complex and become their own universe. Sure it's not the Zig Philosophy.  Zig Compiler(Zig cc) also is a C compiler, and the interoperability from C to Zig is very good. Clearly, we can see influence from other languages like Go and Rust; however, Zig is pretty unique and different from Go and Rust.  Zig is fast. Zig is perfect for system programming. I bet we will see a lot of solutions being built in Zig. As a languages aficionado, I like to learn at least one language per year and sometimes more; Zig was my 2021 pick, did not regret it. Even if you dont use all language...
Keep reading

HMAC in Java

Image
In 2018 AWS CTO(Vogels) said : "Security is everyone's job". For the last 2 years, there was so many famous and big data leaks and breaks that made that statement be very true more than ever. Security often could mean worst performance and worst user experience so in order to get it right you really need to think about the designs before jumping into to code and consider performance and user experience has main requirements.  I was thinking about writing about how to do HMAC in Java for a while and recently Redis 6.0.0 come out and to my surprise, there was a refactoring on the password part in order to use HMAC.  Security easily could scare engineers often because it is not something well spread yet but I believe this will change soon. It does not matter if you have to deal with PII Data or not, security is super relevant because everybody is running their workloads at the cloud or with IoT and Edge devices which means more distribution, more code, more points of fail...
read more »