Mudanças entre as edições de "Comentários - definido em 17/03/16"
De MSTECH wiki
(→Exemplo de comentário de método/função:) |
|||
| (2 revisões intermediárias pelo mesmo usuário não estão sendo mostradas) | |||
| Linha 1: | Linha 1: | ||
| − | + | Retornar para: [[Desenvolvimento Front-End]] | |
| + | == Definições iniciais == | ||
| + | |||
| + | * Comentário em português seguindo o padrão; | ||
| + | * Nomes de funções, métodos e variáveis em inglês. | ||
| + | |||
| + | |||
| + | == Padrão de comentário == | ||
* '''@description''' - descrição da sua função ou do método. ''OBRIGATÓ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 | + | * '''@author''': nome do desenvolvedor e data de criação/alteração. ''OBRIGATÓRIO colocar '''no começo do arquivo JS quando criar''' ou '''na função quando alterar'''.'' |
* '''@param''': descrição do parâmetro (tipo*, nome*, descrição*) | * '''@param''': descrição do parâmetro (tipo*, nome*, descrição*) | ||
* '''@callback''': descrição do callback | * '''@callback''': descrição do callback | ||
| Linha 23: | Linha 30: | ||
} | } | ||
</pre> | </pre> | ||
| + | |||
== IDEs de desenvolvimento == | == IDEs de desenvolvimento == | ||
| Linha 30: | Linha 38: | ||
== Encoding == | == Encoding == | ||
| − | * Todos projetos com UTF-8 | + | * Todos projetos com '''UTF-8''' |
Edição atual tal como às 18h06min de 2 de junho de 2016
Retornar para: Desenvolvimento Front-End
Índice
Definições iniciais
- Comentário em português seguindo o padrão;
- Nomes de funções, métodos e variáveis em inglês.
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 arquivo JS 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/função:
/**
* @description Busca informações de um aluno
* @param {number} _idStudent GUID do estudante
* @param {Function=} _callback Executa a função passada
*
* @author rodrigo.edamatsu - 02.06.16
*/
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
