Manual do Desenvolvedor - Histórico de revisão

Adm: /* Organização dos projetos */

2011-09-29T12:55:33Z

‎Organização dos projetos

Adm: /* Organização dos projetos */

2011-09-29T12:55:13Z

‎Organização dos projetos

Adm: /* Organização dos projetos */

2011-09-29T12:53:08Z

‎Organização dos projetos

Adm: /* Organização dos projetos */

2011-09-29T12:48:14Z

‎Organização dos projetos

Adm: /* Organização dos projetos */

2011-09-29T12:46:05Z

‎Organização dos projetos

Adm em 12h42min de 29 de setembro de 2011

2011-09-29T12:42:04Z

Adm: /* Tipos de visibilidade */

2011-09-29T12:24:09Z

‎Tipos de visibilidade

Adm: /* Regras de Nomeação */

2011-09-29T12:18:07Z

‎Regras de Nomeação

Adm: /* Regras de Nomeação */

2011-09-29T12:17:18Z

‎Regras de Nomeação

Adm: /* Regras de Nomeação */

2011-09-29T12:11:29Z

‎Regras de Nomeação

@@ Linha 340: / Linha 340: @@
 :::: '''paginas''' - arquivos .jsp/.xhtml/.html/.ftl
 ::: '''META-INF'''
-:: arquivos .swf
+::: arquivos .swf

@@ Linha 336: / Linha 336: @@
 :: '''WebContent'''
 ::: '''resources''' - diretório contendo imagens, scripts e folha de estilos
 ::: '''WEB-INF'''
 ::: '''META-INF'''

@@ Linha 336: / Linha 336: @@
 :: '''WebContent'''
 ::: '''resources''' - diretório contendo imagens, scripts e folha de estilos
 ::: '''WEB-INF'''
 ::: '''META-INF'''

@@ Linha 306: / Linha 306: @@
 * logs.core.util
 * logs.core.properties
 '''Estrutura de diretórios:''' estrutura de diretórios de um projeto web.

@@ Linha 288: / Linha 288: @@
 == Organização dos projetos ==
-Nome de projeto: o nome do projeto deve estar em minúsculo e composto pela funcionalidade e módulo.
+'''Nome de projeto:''' o nome do projeto deve estar em minúsculo e composto pela funcionalidade e módulo.
 Exemplo:
@@ Linha 296: / Linha 296: @@
 * hibernate-core
-Nome de pacotes: o nome do pacote deve se composto pela funcionalidade, módulo e recursos.
+'''Nome de pacotes:''' o nome do pacote deve se composto pela funcionalidade, módulo e recursos.
 Exemplo:
@@ Linha 307: / Linha 307: @@
 * logs.core.properties
-Estrutura de diretórios:
+'''Estrutura de diretórios:''' estrutura de diretórios de um projeto web.
-•	<funcionalidade-modulo>
+: '''<funcionalidade-modulo>'''
-o	build
+:: '''build'''
-	producao - diretório contendo as configurações do ambiente de produção
+::: '''producao''' - diretório contendo as configurações do ambiente de produção
-•	empresa_x - configurações específicas da empresa x
+:::: '''empresa_x''' - configurações específicas da empresa x
-•	empresa_y - configurações específicas da empresa y
+:::: '''empresa_y''' - configurações específicas da empresa y
-	homologacao - diretório contendo as configurações do ambiente de homologação
+::: '''homologacao''' - diretório contendo as configurações do ambiente de homologação
-•	empresa_x - configurações específicas da empresa x
+:::: '''empresa_x''' - configurações específicas da empresa x
-•	empresa_y - configurações específicas da empresa y
+:::: '''empresa_y''' - configurações específicas da empresa y
-	teste - diretório contendo as configurações do ambiente de testes
+::: '''teste''' - diretório contendo as configurações do ambiente de testes
-•	empresa_x - configurações específicas da empresa x
+:::: '''empresa_x''' - configurações específicas da empresa x
-•	empresa_y - configurações específicas da empresa y
+:::: '''empresa_y''' - configurações específicas da empresa y
-o	src - diretório contendo os arquivos fontes do projetos
+:: '''src''' - diretório contendo os arquivos fontes do projetos
-o	src-test - contendo os testes unitários e funcionais
+:: '''src-test''' - contendo os testes unitários e funcionais
-o	WebContent
+:: '''WebContent'''
-	resources - diretório contendo imagens, scripts e folha de estilos
+::: '''resources''' - diretório contendo imagens, scripts e folha de estilos
-	WEB-INF
+::: '''WEB-INF'''
-	META-INF
+::: '''META-INF'''

← Edição anterior		Edição das 12h42min de 29 de setembro de 2011
Linha 285:		Linha 285:

	Como boa prática manter sempre uma sentença (statement) por linha em um programa.		Como boa prática manter sempre uma sentença (statement) por linha em um programa.
		+
		+	== Organização dos projetos ==
		+
		+	Nome de projeto: o nome do projeto deve estar em minúsculo e composto pela funcionalidade e módulo.
		+
		+	Exemplo:
		+
		+	* logs-core
		+	* logs-view
		+	* hibernate-core
		+
		+	Nome de pacotes: o nome do pacote deve se composto pela funcionalidade, módulo e recursos.
		+
		+	Exemplo:
		+
		+	* logs.core
		+	* logs.core.model
		+	* logs.core.view
		+	* logs.core.control
		+	* logs.core.util
		+	* logs.core.properties
		+
		+	Estrutura de diretórios:
		+
		+	• <funcionalidade-modulo>
		+	o build
		+	 producao - diretório contendo as configurações do ambiente de produção
		+	• empresa_x - configurações específicas da empresa x
		+	• empresa_y - configurações específicas da empresa y
		+	 homologacao - diretório contendo as configurações do ambiente de homologação
		+	• empresa_x - configurações específicas da empresa x
		+	• empresa_y - configurações específicas da empresa y
		+	 teste - diretório contendo as configurações do ambiente de testes
		+	• empresa_x - configurações específicas da empresa x
		+	• empresa_y - configurações específicas da empresa y
		+	o src - diretório contendo os arquivos fontes do projetos
		+	o src-test - contendo os testes unitários e funcionais
		+	o WebContent
		+	 resources - diretório contendo imagens, scripts e folha de estilos
		+	 WEB-INF
		+	 META-INF

@@ Linha 26: / Linha 26: @@
 '''Protected''' - Somente métodos declarados na classe, ou qualquer subclasse, ou qualquer classe existente no mesmo pacote poderão acessar.
-'''--Default --''' Somente métodos declarados na classe ou qualquer classe que esteja no mesmo pacote. O uso do default se faz pela ausência de qualquer keyword para especificar visibilidade.
+'''-- Default --''' Somente métodos declarados na classe ou qualquer classe que esteja no mesmo pacote. O uso do default se faz pela ausência de qualquer keyword para especificar visibilidade.
 '''Public''' - Todas as classes podem acessar.

@@ Linha 155: / Linha 155: @@
 * '''Outros objetos:''' os nomes devem estar sempre com todos os caracteres minúsculos.
 {| border=1 cellspacing=0 cellpadding=5
 ! Extensão
@@ Linha 174: / Linha 175: @@
 | Arquivos no formato XML
 |}
 == Expressões e Sentenças ==

@@ Linha 98: / Linha 98: @@
 O Java não tem limite para o nome de classes, métodos ou variáveis. Seguem algumas regras a serem adotadas para compor os nomes:
-* '''Constantes:''' use sempre letras maiúsculas separando os nomes por underscore. Por exemplo: MAX_VALUE. O nome da constante deve ser claro e sua definição deve pertencer a uma classe cujo objetivo tenha afinidade com a função da constante. Também é utilizada a regra para utilização dos tipos enumerados. <br> Nota: Constantes são variáveis para serem definidas como final e static. Em geral as constantes devem ser utilizadas para representar literais.
+* '''Constantes:''' use sempre letras maiúsculas separando os nomes por underscore. Por exemplo: MAX_VALUE. O nome da constante deve ser claro e sua definição deve pertencer a uma classe cujo objetivo tenha afinidade com a função da constante. Também é utilizada a regra para utilização dos tipos enumerados. <p> Nota: Constantes são variáveis para serem definidas como final e static. Em geral as constantes devem ser utilizadas para representar literais.</p>
-* '''Variáveis privadas e parâmetros:''' utilize letras minúsculas para o primeiro nome. Os nomes devem estar em português e fazer sentido para a função da variável. Eles serão compostos de tantos nomes quanto forem necessários emendados entre si (sem espaços) e sem utilizar o underscore (_) respeitando um máximo de não mais de 30 caracteres. Não use nomes abreviados. <br> Nota: O nome da variável deve ser totalmente legível.
+* '''Variáveis privadas e parâmetros:''' utilize letras minúsculas para o primeiro nome. Os nomes devem estar em português e fazer sentido para a função da variável. Eles serão compostos de tantos nomes quanto forem necessários emendados entre si (sem espaços) e sem utilizar o underscore (_) respeitando um máximo de não mais de 30 caracteres. Não use nomes abreviados. <p> Nota: O nome da variável deve ser totalmente legível.</p>
 * '''Métodos:''' use letra minúscula no primeiro nome. Os nomes devem estar em português e fazer sentido para o objetivo do método. Eles serão compostos de tantos nomes quanto forem necessários emendados entre si (sem espaços) e sem utilizar o underscore (_). Não use nomes abreviados. A utilização do português como padrão se excetua na utilização de prefixos já comumente utilizados em programas e que tem um contexto já bem definido como por exemplo:
 {| border=1 cellspacing=0 cellpadding=5
 |-
@@ Linha 121: / Linha 122: @@
 | Métodos que fazem teste e retornam um valor booleano
 |}
 * '''Classes e interface:''' use letra maiúscula na primeira letra do nome. Use nomes descritivos. Para interfaces, o nome deve possuir o prefixo I (letra i maíucula)
 {| border=1 cellspacing=0 cellpadding=5
 ! Sufixo
@@ Linha 146: / Linha 149: @@
 | Para classes cuja função seja de Busines Delegate action Para as classes que tem o papel de actions da camada de apresentação
 |}
 * '''Packages:''' use letras minúsculas em todos os nomes.