Mudanças entre as edições de "Comentários - definido em 17/03/16"
De MSTECH wiki
(Criou página com '== Padrão de comentário == ; @description: descrição da sua função ou do método. (OBRIGATÓRIO) ; @author: nome do desenvolvedor. (OBRIGATÓRIO) ; @param: descrição...') |
|||
| Linha 1: | Linha 1: | ||
== Padrão de comentário == | == Padrão de comentário == | ||
| − | + | ||
| − | + | * '''@description''' - descrição da sua função ou do método. ''OBRIGATÓRIO'' | |
| − | + | * '''@author''': nome do desenvolvedor e data de criação/alteração. ''OBRIGATÓRIO colocar no começo do script quando criar ou na função quando alterar.'' | |
| − | + | * '''@param''': descrição do parâmetro (tipo*, nome*, descrição*) | |
| − | + | * '''@callback''': descrição do callback | |
| + | * '''@returns''' descrição do retorno (tipo*, nome*, descrição*). | ||
| + | |||
| + | |||
| + | ==== Exemplo de comentário de método: ==== | ||
| + | <pre> | ||
| + | /** | ||
| + | * @description Busca informações de um aluno | ||
| + | * @param {number} _idStudent GUID do estudante | ||
| + | * @param {Function=} _callback Executa a função passada | ||
| + | */ | ||
| + | function getStudentInformation (_idStudent, _callback) { | ||
| + | ... | ||
| + | } | ||
| + | </pre> | ||
== IDEs de desenvolvimento == | == IDEs de desenvolvimento == | ||
* '''Visual Studio''' para projetos .net | * '''Visual Studio''' para projetos .net | ||
* '''Webstorm''' e/ou '''Atom''' para demais projetos | * '''Webstorm''' e/ou '''Atom''' para demais projetos | ||
| + | |||
== Encoding == | == Encoding == | ||
* Todos projetos com UTF-8 | * Todos projetos com UTF-8 | ||
Edição das 14h44min de 2 de junho de 2016
Índice
Padrão de comentário
- @description - descrição da sua função ou do método. OBRIGATÓRIO
- @author: nome do desenvolvedor e data de criação/alteração. OBRIGATÓRIO colocar no começo do script quando criar ou na função quando alterar.
- @param: descrição do parâmetro (tipo*, nome*, descrição*)
- @callback: descrição do callback
- @returns descrição do retorno (tipo*, nome*, descrição*).
Exemplo de comentário de método:
/**
* @description Busca informações de um aluno
* @param {number} _idStudent GUID do estudante
* @param {Function=} _callback Executa a função passada
*/
function getStudentInformation (_idStudent, _callback) {
...
}
IDEs de desenvolvimento
- Visual Studio para projetos .net
- Webstorm e/ou Atom para demais projetos
Encoding
- Todos projetos com UTF-8
