Posts

Showing posts with the label code-style

Team Code Review & Design Sessions

XP is about getting the right values and practices and maximize it to the extreme. CODE it's essential and practices like pair programming and unit testing / test driven are a must have. I don't think they are enough, so i like to work a lot with team code reviews and design sessions. As a Software Architect I found such techniques very effective specially in scenarios that the team is beginning with XP and don't do pair programming effective or the team technical skills have a huge contrast.  I'm not against pair programming of testing BUT this old fashion techniques work as well.

Code Conventions for the JavaTM Programming Language

Pessoal talvez vocês em uma primeira impressão achem graça disso, mas acredito que nem todos os desenvolvedores java conhecem bem esses padrões. Segue o link de referencia: code conventions Por que isso? Esse dias ao conversar com outros desenvolvedores e ao ver códigos via algumas coisas que me deixaram inquieto como: public boolean validaCPFandCNPJ(String arg0){...} public class CNPJ{...} Segundo o documento da Sun esses dois exemplos estão errados. O correto seria: public boolean validaCpfAndCnpj(String arg0){...} public class Cnpj{...} Para métodos é preciso respeitar o camelCase. Mas uma dais coisas mais bizarras que eu via foi uma classe da oracle que vem no driver jdbc deles o jdbc14.jar tinha uma classe com esse nome: STRUCT olha só que legal isso(ironia rsrsrs): STRUCT struct = new STRUCT(); Horrível... Mas a sun, dentro do jdk e da API também tem alguns nomes esdrúxulos. A Nomenclatura e padrão de codificação é muito importante, leiam esse documento e sigam. Se não que Crom...

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 ...