Mudanças entre as edições de "Comentários - definido em 17/03/16"

De MSTECH wiki
Ir para: navegação, pesquisa
(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...')
 
 
(6 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 ==
 
== 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: ====
 +
 +
<pre>
 +
/**
 +
* @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) {
 +
  ...
 +
}
 +
</pre>
  
−
; @description: descrição da sua função ou do método. (OBRIGATÓRIO)
 
−
; @author: nome do desenvolvedor. (OBRIGATÓRIO)
 
−
; @param: descrição do parametro (tipo*, nome*, descrição*)
 
−
; @callback: descrição do callback (tipo*)
 
−
; @return ou @returns (caso o retorno seja mais do que um): descrição do retorno (nome, tipo*, descrição*).
 
  
 
== 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 atual tal como às 18h06min de 2 de junho de 2016

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
  • @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
Disponível em "http://wiki.mstech.com.br/index.php?title=Comentários_-_definido_em_17/03/16&oldid=444"