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

Kafka Streams with Java 15

Image
Kafka Streams is a Streaming library similar to Spark and Flink which works with Apache Kafka. Kafka stream can be useful to process historical and near-real-time big data workloads but also for non-realtime analytical computations at scale for the online world as well. Kafka-Streams is elastic, highly scalable, fault-tolerant, and fully integrated with Kafka. You can use Kafka Stream with Java, Scala, Kotlin JVM applications and also have exactly-once processing semantics. Kafka-Streams is being used by the New York Times, Pinterest, Line, Trivago, Zalando, and many other companies. Today I want to share a video of Kafka-Streams running with Kafka 2.6 and Java JDK 15. So Let's get started. 
read more »

Rust and Java Interoperability

Image
Rust does not stop for one second to amaze me. It looks like Rust was designed to talk to every other language so easily. No kidding, it's clear way Web Assembly and rust have lots in common. Java is never an easy lang to interop with. Today I will show how easily we can interop Java & Rust. In order to do so, we will need to use the Java and Rust compilers. For Java, we will not require any other lib than the standard JDK. For Rust, we will need to create a lib project in cargo and we will need to use the crate JNI. I love this feature because java does not allow low-level code on the main language. So if we need to do something low level, efficiently Rust is my first choice, not only for safety reasons but because is really fast.  Let's get started.
read more »

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 »