Comentários - definido em 17/03/16 - Histórico de revisão

Rodrigo.edamatsu em 18h06min de 2 de junho de 2016

2016-06-02T18:06:31Z

Rodrigo.edamatsu: /* Padrão de comentário */

2016-06-02T14:52:28Z

‎Padrão de comentário

Rodrigo.edamatsu: /* Encoding */

2016-06-02T14:50:41Z

‎Encoding

Rodrigo.edamatsu: /* Exemplo de comentário de método/função: */

2016-06-02T14:50:19Z

‎Exemplo de comentário de método/função:

Rodrigo.edamatsu: /* Exemplo de comentário de método: */

2016-06-02T14:47:08Z

‎Exemplo de comentário de método:

Rodrigo.edamatsu: /* Exemplo de comentário de método: */

2016-06-02T14:46:31Z

‎Exemplo de comentário de método:

Rodrigo.edamatsu em 14h44min de 2 de junho de 2016

2016-06-02T14:44:41Z

Rodrigo.edamatsu: 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...'

2016-05-24T13:39:28Z

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...'

Página nova

== 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 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 ==
* '''Visual Studio''' para projetos .net
* '''Webstorm''' e/ou '''Atom''' para demais projetos

== Encoding ==
* Todos projetos com UTF-8

@@ Linha 1: / Linha 1: @@
-== Padrão de comentário ==
+Retornar para: [[Desenvolvimento Front-End]]
 * '''@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'''.''
@@ Linha 23: / Linha 30: @@
+}
 </pre>
 == IDEs de desenvolvimento ==

@@ Linha 3: / Linha 3: @@
 * '''@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.''
+* '''@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

← Edição anterior		Edição das 14h50min de 2 de junho de 2016
Linha 30:		Linha 30:

	== Encoding ==		== Encoding ==
−	* Todos projetos com UTF-8	+	* Todos projetos com '''UTF-8'''

@@ Linha 10: / Linha 10: @@
 ==== Exemplo de comentário de método/função: ====
 <pre>
 /**

@@ Linha 9: / Linha 9: @@
-==== Exemplo de comentário de método: ====
+==== Exemplo de comentário de método/função: ====
 <pre>
 /**

@@ Linha 15: / Linha 15: @@
   * @param {number}          _idStudent           GUID do estudante
   * @param {Function=}       _callback            Executa a função passada
   */
 function getStudentInformation (_idStudent, _callback) {

@@ Linha 1: / Linha 1: @@
 == Padrão de comentário ==
-; @description: descrição da sua função ou do método. (OBRIGATÓRIO)
-; @author: nome do desenvolvedor. (OBRIGATÓRIO)
+* '''@description''' - descrição da sua função ou do método. ''OBRIGATÓRIO''
-; @param: descrição do parametro (tipo*, nome*, descrição*)
+* '''@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.''
-; @callback: descrição do callback (tipo*)
+* '''@param''': descrição do parâmetro (tipo*, nome*, descrição*)
-; @return ou @returns (caso o retorno seja mais do que um): descrição do retorno (nome, tipo*, descrição*).
+* '''@callback''': descrição do callback
 == IDEs de desenvolvimento ==
 * '''Visual Studio''' para projetos .net
 * '''Webstorm''' e/ou '''Atom''' para demais projetos
 == Encoding ==
 * Todos projetos com UTF-8