Claro, JavaScript é uma linguagem tipada dinamicamente, mas descobri que ter uma notação explícita é a maneira mais rápida de comunicar a outro desenvolvedor como usar um módulo que escrevi.
Eu escrevi jsig – notação de assinatura JavaScript – para formalizar a notação que estamos usando em nossa base de código no trabalho e na documentação para meus módulos npm.
Esta é a aparência:
// ({stderr: ReadStream, stdout: ReadStream }) => void
function log(stdio) {
file = require('fs').createWriteStream('io.log')
stdio.stdout.pipe(file)
stdio.stderr.pipe(file)
}jsig ajuda a escrever comentários de função claros e precisos e documentação com menos palavras e menos ambigüidade.
Tem algum feedback? Por favor, contribua e abra um problema no repositório GitHub .
Você pode ver o jsig em ação no leia-me do minq