Código com documentação !

gokernel
(usa Linux Mint)

Enviado em 28/08/2018 - 01:36h

Olá pessoal !


Estava sem dormir e me "iluminou" uma ideia !


SEGUINTE:
Tenho uma API e falta certificar todas as funções que sejam 32/64 BITS ... então me veio a ideia de codificar tipo assim as funções em C:

void emit_mov_reg_var (ASM *a, int reg, void *var) { ///: 32/64 BITS OK: Move: %register to variable.

    // bla, bla, bla ...

}



void Funcao_algua_coisa (int i) { ///: Um pequena descricao sobre essa funcao ...

    // bla, bla, bla ...

}

 

Codificando deste modo fica fácil se quiser um "help" rápido sem "gastar muito tempo escrevendo" uma Documentação.

01: Então vc me pergunta 1:
Cara, e como faço para "ver a Documentação" ?

RESPOSTA:

    grep "///:" nome_do_arquivo.c



 

02: Então vc me informa 2:
Cara, tu "manja" que existe o Doxygen, sabe o que é ?

RESPOSTA:
rasrsrs ("risos") ... já tentou usar essa parada em um Linux em modo somente texto ???

03: Então vc me pergunta:
O que é esse negócio de "grep" ?

RESPOSTA:
rasrsrs ... lamento que vc não saiba ... goto google ;)


Ou usar assim:

void Funcao (int i) { //! Um pequena descricao sobre essa funcao ... compatível com o Doxygen

    // bla, bla, bla ...

}

e

grep "//!" nome_do_arquivo.?



 

Bom, isso foi só uma ideia para se aprimorar !

O que dizem ???