Métodos – Item 44

Postado em

javadoc_screenEscreva documentação javadoc para todos os elementos expostos da API

É frustrante e propenso a erros usar ou dar manutenção em uma API sem a devida documentação JavaDoc, principalmente quando foram idealizadas por diferentes profissionais ao longo de tempo. Em alguns casos se torna até impossível de fazê-lo. Dessa forma, é considerado obrigatório à devida documentação de todos os elementos existentes em uma API – interfaces, classes, construtores, atributos, métodos, enums, generics e anotações. Consulte o manual oficial de como usar e como fazer corretamente um JavaDoc.

Para todas as informações, veja o post inicial.

“Disse-lhe o senhor: Muito bem, servo bom e fiel; foste fiel no pouco, sobre o muito te colocarei; entra no gozo do teu senhor.” Mateus 25:21

Anúncios