cvs commit: jakarta-alexandria/src/test/resources/js Sicredi0003.js Sicredi0002.js PadraoJS.js

[email protected] 28 Mar 2003 08:11:29 -0000
Newsgroups gmane.comp.jakarta.alexandria.devel
Message-ID <[email protected]>
nicolaken    2003/03/28 00:11:29

  Added:       src/test/resources/js Sicredi0003.js Sicredi0002.js
                        PadraoJS.js
  Log:
  jsdoc tests
  
  Revision  Changes    Path
  1.1                  jakarta-alexandria/src/test/resources/js/Sicredi0003.js
  
  Index: Sicredi0003.js
  ===================================================================
  /**
  * @summary Funções de tratamento de datas.
  * @summary Funções de impressão.
  */
  
  Padrão de codificação JavaScript:
  
  Declaração de variáveis:
  
  O nome da variável deverá ser iniciado por letra minúscula,
  e suas palavras não serão separadas por espaço, e sim pela
  inicial da palavra maiúscula.
  Para cada declaração de variável, deverá ser incluído um 
  comentário com a sua funcionalidade, como no exemplo:
  
  var nomeCliente; // armazena o nome do cliente
  var endResidCliente; // armazena o endereço residencial do cliente;
  
  
  Declaração de funções:
  
  O nome da função deverá ser iniciado por letra minúscula,
  e suas palavras não serão separadas por espaço, e sim pela
  inicial da palavra maiúscula.
  Para cada declaração de função, deverá ser incluído um 
  comentário com a sua funcionalidade, como no exemplo:
  
  /**
  * fecha uma modal que está ativada 					
  * @author Mailton Almeida											
  * @param x: um parâmetro qualquer												
  * @return um retorno qualquer 
  */
  
  function fechaModal(){
  	...
  }
  
  /**
  * função de teste 					
  * @author Mailton Almeida											
  * @param nome: o nome do cliente
  * @param agencia: a agencia onde o cliente possui conta
  * @return a conta do cliente 
  */
  
  function funcaoTeste(nome, agencia)
  {
  	...
  }
  
  
  Declaração de blocos condicionais deverão conter um
  comentário ao final de cada bloco descrevendo a
  condição de entrada para cada caso.
  Trechos de código que pertencerem a um bloco condicional
  deverão ser identados com um "tab".
  
  Ex:
  
  if(navigator.appName == "Netscape"){	//se o browser for o netscape	
  	self.window.close();
  }else{ 									//se o browser for o IE
  	window.close();
  }
  
  
  
  
  1.1                  jakarta-alexandria/src/test/resources/js/Sicredi0002.js
  
  Index: Sicredi0002.js
  ===================================================================
  /**
  * @summary Funções de auxílio à cálculos monetários.
  */
  
  Padrão de codificação JavaScript:
  
  Declaração de variáveis:
  
  O nome da variável deverá ser iniciado por letra minúscula,
  e suas palavras não serão separadas por espaço, e sim pela
  inicial da palavra maiúscula.
  Para cada declaração de variável, deverá ser incluído um 
  comentário com a sua funcionalidade, como no exemplo:
  
  var nomeCliente; // armazena o nome do cliente
  var endResidCliente; // armazena o endereço residencial do cliente;
  
  
  Declaração de funções:
  
  O nome da função deverá ser iniciado por letra minúscula,
  e suas palavras não serão separadas por espaço, e sim pela
  inicial da palavra maiúscula.
  Para cada declaração de função, deverá ser incluído um 
  comentário com a sua funcionalidade, como no exemplo:
  
  /**
  * fecha uma modal que está ativada 					
  * @author Mailton Almeida											
  * @param x: um parâmetro qualquer												
  * @return um retorno qualquer 
  */
  
  function fechaModal(){
  	...
  }
  
  /**
  * função de teste 					
  * @author Mailton Almeida											
  * @param nome: o nome do cliente
  * @param agencia: a agencia onde o cliente possui conta
  * @return a conta do cliente 
  */
  
  function funcaoTeste(nome, agencia)
  {
  	...
  }
  
  
  Declaração de blocos condicionais deverão conter um
  comentário ao final de cada bloco descrevendo a
  condição de entrada para cada caso.
  Trechos de código que pertencerem a um bloco condicional
  deverão ser identados com um "tab".
  
  Ex:
  
  if(navigator.appName == "Netscape"){	//se o browser for o netscape	
  	self.window.close();
  }else{ 									//se o browser for o IE
  	window.close();
  }
  
  
  
  
  1.1                  jakarta-alexandria/src/test/resources/js/PadraoJS.js
  
  Index: PadraoJS.js
  ===================================================================
  /**
  * @summary Funções para validação de campos de formulário.afasdafasdfas
  * @summary Funções para formatação de CPF, CNPJ, e CC. 
  * 
  */
  
  Padrão de codificação JavaScript:
  
  Declaração de variáveis:
  
  O nome da variável deverá ser iniciado por letra minúscula,
  e suas palavras não serão separadas por espaço, e sim pela
  inicial da palavra maiúscula.
  Para cada declaração de variável, deverá ser incluído um 
  comentário com a sua funcionalidade, como no exemplo:
  
  var nomeCliente; // armazena o nome do cliente
  var endResidCliente; // armazena o endereço residencial do cliente;
  
  
  Declaração de funções:
  
  O nome da função deverá ser iniciado por letra minúscula,
  e suas palavras não serão separadas por espaço, e sim pela
  inicial da palavra maiúscula.
  Para cada declaração de função, deverá ser incluído um 
  comentário com a sua funcionalidade, como no exemplo:
  
  /**
  * fecha uma modal que está ativada	
  * @author Mailton Almeida											
  * @param x: um parâmetro qualquer												
  * @return um retorno qualquer 
  */
  
  function fechaModal(){
  	...
  }
  
  /**
  * função de teste 					
  * @author Mailton Almeida											
  * @param nome: o nome do cliente
  * @param agencia: a agencia onde o cliente possui conta
  * @return a conta do cliente 
  */
  
  function funcaoTeste(nome, agencia)
  {
  	...
  }
  
  
  Declaração de blocos condicionais deverão conter um
  comentário ao final de cada bloco descrevendo a
  condição de entrada para cada caso.
  Trechos de código que pertencerem a um bloco condicional
  deverão ser identados com um "tab".
  
  Ex:
  
  if(navigator.appName == "Netscape"){	//se o browser for o netscape	
  	self.window.close();
  }else{ 									//se o browser for o IE
  	window.close();
  }