Convenção desenvolvedor

Convenção desenvolvedor 1.1 (Edição mínima)

Test Test — Wed, 09 Jan 2013 20:00:46 GMT

Linha 1

<<TableOfContents>>

Linha 2

Linha 3

Linha 4

[[Convencao desenvolvedor/Convencao nomes|Convenção de Nomes]]

Linha 5

[[Convencao desenvolvedor/Convencao codigo|Convenção de Código]]

Linha 6

Linha 7

Linha 8

Linha 9

Linha 1

~~New~~

Convenção desenvolvedor 1.2 (Edição mínima)

Test Test — Wed, 09 Jan 2013 20:00:46 GMT

Linha 3

<<TableOfContents>>

== Objetivos e Princípios ==

Linha 5

Este documento tem como finalidade determinar os padrões e convenções a serem seguidos no desenvolvimento de aplicações em Java pelos desenvolvedores do Framework Demoiselle [1]. Para a leitura deste documento é recomendável o conhecimento prévio da linguagem Java [2].

Linha 6

Linha 7

Uma padronização na programação precisa ser adotada a fim de manter consistente por todo um projeto e para facilitar subsequentes manutenções corretivas e evolutivas em seu código. Além disso, o uso de componentes de software é facilitado através da adequação aos padrões internacionais.

Linha 8

Linha 9

A Sun Microsystems publicou em 1997 um padrão de desenvolvimento para a linguagem Java entitulado "Java Code Conventions" [3]. Tais regras tornaram-se o padrão no mundo do desenvolvimento Java. O presente documento apenas aponta e especifica tais regras levando em consideração o contexto específico do Framework Demoiselle.

Linha 10

Linha 11

Este documento também baseou-se no documento "Padrões e Convenções para Código Java" elaborado para o Framework Pinhão Paraná [4], da CELEPAR.

Linha 12

Linha 13

== Idioma ==

Linha 14

Linha 15

Para a nomeação de artefatos de código e documentação destes na forma de comentários no Framework Demoiselle é recomendada a utilização do idioma inglês.

Linha 16

Linha 17

Para aplicações específicas, o projetista é livre para nomear classes, variáveis e métodos de acordo com termos específicos à regra de negócio em sua língua original, porém é recomendável adotar a língua inglesa quando da existência de componentes técnicos potencialmente reusáveis desenvolvidos na aplicação.

Linha 18

Linha 19

Linha 4

~~[[Convencao desenvolvedor/Convencao nomes|Convenção de Nomes]]~~

Linha 21

[[Convencao desenvolvedor/Convencao codigo|Convenção de Código]]

[[Convencao desenvolvedor/Convencao nomes|Convenção de Nomes]]

Convenção desenvolvedor 1.3 (Edição mínima)

Test Test — Wed, 09 Jan 2013 20:00:46 GMT

Linha 3

== Objetivos e Princípios ==

== Objetivos e princípios ==

Linha 10

Linha 12

== Convenção de idioma ==

Linha 13

~~== Idioma ==~~

Linha 18

== Caracteres utilizáveis ==

Linha 20

Em geral a nomeação de classes, aprâmetros, atributos e métodos usa as seguintes faixas de caracteres alfanuméricos: a-z, A-Z e 0-9. A utilização de caracteres especiais ("?", "!", "@", "ç", ...) e acentos ("á", "ã", "é", "í", "ó", ...) nos nomes é proibida. O underscore "_" pode ser utilizado para a nomeação de constantes ou de valores enumerados.

Linha 20

~~[[Convencao desenvolvedor/Convencao codigo|Convenção de Código]]~~

Linha 22

== Legibilidade ==

Linha 22

~~[[Convencao desenvolvedor/Convencao nomes|Convenção de Nomes]]~~

Linha 24

Como em qualquer linguagem, é muito importante fornecer comentários relevantes ao código. Por exemplo, é inútil repetir o nome de um método na forma de uma sentença. A preferência deve sempre ser dada aos identificadores (nomes de atributos, métodos, etc) com comentários sucintos.

Linha 26

O princípio importante a ser adotado é a legibilidade do código. Os códigos fontes de um programa interessam tanto ao compilador quanto ao desenvolvedor. Devemos lembrar todas as vezes que o código precisará ser mantido. E essa manutenção, corretiva ou evolutiva, por vezes é efetuada por outra pessoa diferente do desenvolvedor inicial.

Linha 28

== Links ==

* [[Convencao desenvolvedor/Convencao codigo|Convenção de Código]]

* [[Convencao desenvolvedor/Convencao nomes|Convenção de Nomes]]

* [[Convencao desenvolvedor/Teste unitario|Teste Unitário]]

* [[Convencao desenvolvedor/Log|Log]]

Convenção desenvolvedor 1.4 (Edição mínima)

Test Test — Wed, 09 Jan 2013 20:00:46 GMT

Convenção desenvolvedor 1.5 (Edição mínima)

Test Test — Wed, 09 Jan 2013 20:00:46 GMT

Linha 30

* [[Convencao desenvolvedor/Convencao codigo|Convenção de Código]]

* [[Convenção desenvolvedor/Convenção código|Convenção de Código]]

Linha 31

* [[Convencao desenvolvedor/Convencao nomes|Convenção de Nomes]]

* [[Convenção desenvolvedor/Convenção nomes|Convenção de Nomes]]

Linha 32

* [[Convencao desenvolvedor/Teste unitario|Teste Unitário]]

* [[Convenção desenvolvedor/Teste unitário|Teste Unitário]]

Linha 33

* [[Convencao desenvolvedor/Log|Log]]

* [[Convenção desenvolvedor/Log|Log]]

Convenção desenvolvedor 1.6 (Edição mínima)

Test Test — Wed, 09 Jan 2013 20:00:46 GMT

Linha 5

Este documento tem como finalidade determinar os padrões e convenções a serem seguidos no desenvolvimento de aplicações em Java pelos desenvolvedores do **[[http://www.frameworkdemoiselle.gov.br/|Framework Demoiselle]]**. Para a leitura deste documento é recomendável o conhecimento prévio da **[[http://java.sun.com/|linguagem Java]]**.

Linha 9

A Sun Microsystems publicou em 1997 um padrão de desenvolvimento para a linguagem Java entitulado "Java Code Conventions~~" [3~~]. Tais regras tornaram-se o padrão no mundo do desenvolvimento Java. O presente documento apenas aponta e especifica tais regras levando em consideração o contexto específico do Framework Demoiselle.

A **Sun Microsystems** publicou em 1997 um padrão de desenvolvimento para a linguagem Java entitulado **[[http://java.sun.com/docs/codeconv/|Java Code Conventions]]**. Tais regras tornaram-se o padrão no mundo do desenvolvimento Java. O presente documento apenas aponta e especifica tais regras levando em consideração o contexto específico do **Framework Demoiselle**.

Linha 10

Este documento também baseou-se no documento "Padrões e Convenções para Código Java" elaborado para o Framework Pinhão Paraná [4], da CELEPAR.

Este documento também baseou-se no documento "Padrões e Convenções para Código Java" elaborado para o **[[http://www.frameworkpinhao.pr.gov.br/|Framework Pinhão Paraná]]**, da **CELEPAR**.

Linha 14

Para a nomeação de artefatos de código e documentação destes na forma de comentários no Framework Demoiselle é recomendada a utilização do idioma inglês.

Para a nomeação de artefatos de código e documentação destes na forma de comentários no Framework Demoiselle é recomendada a utilização do **idioma inglês**.

Linha 20

Em geral a nomeação de classes, parâmetros, atributos e métodos usa as seguintes faixas de caracteres alfanuméricos: a-z, A-Z e 0-9. A utilização de caracteres especiais ("?", "!", "@", "ç", ...) e acentos ("á", "ã", "é", "í", "ó", ...) nos nomes é proibida. O underscore "_" pode ser utilizado para a nomeação de constantes ou de valores enumerados.

Linha 34

* [[Convenção desenvolvedor/Teste unitário|Teste Unitário]]

* [[Convenção desenvolvedor/Log|Log]]

* [[Convenção desenvolvedor/Teste unitário|Teste Unitário]]

* [[Convenção desenvolvedor/Log|Log]]

Convenção desenvolvedor 1.7 (Edição mínima)

Test Test — Wed, 09 Jan 2013 20:00:46 GMT

Convenção desenvolvedor 1.8 (Edição mínima)

Test Test — Wed, 09 Jan 2013 20:00:47 GMT

Convenção desenvolvedor 1.9 (Edição mínima)

Test Test — Wed, 09 Jan 2013 20:00:47 GMT

Convenção desenvolvedor 2.0 (Edição mínima)

Test Test — Wed, 09 Jan 2013 20:00:47 GMT

Linha 28

== Repositório de Fontes ==

Linha 29

Linha 30

O repositório oficial de fontes, a partir da versão 2, é o [[https://github.com/demoiselle/|GitHub]] os códigos das versões anteriores continuam no SVN http://svn.frameworkdemoiselle.gov.br/ neste [[http://www.frameworkdemoiselle.gov.br/documentacaodoprojeto/manuais-e-tutoriais/manuais/guia-demoiselle-nimble-com-eclipse-github-groovy|link]] você encontrará um guia para uso do Github.

Linha 31

Linha 32

== Convenções para codificação ==

Linha 28

~~== Links ==~~

Convenção desenvolvedor 2.1

Test Test — Mon, 08 Apr 2013 17:30:08 GMT

Linha 7

Linha 10

Linha 18

Linha 29

Linha 30

Linha 34

O repositório oficial de fontes, a partir da versão 2, é o [[https://github.com/demoiselle/|GitHub]] os códigos das versões anteriores continuam no SVN [[http://svn.frameworkdemoiselle.gov.br/|http://svn.frameworkdemoiselle.gov.br/]] neste [[http://www.frameworkdemoiselle.gov.br/documentacaodoprojeto/manuais-e-tutoriais/manuais/guia-demoiselle-nimble-com-eclipse-github-groovy|link]] você encontrará um guia para uso do Github.

Linha 37

*[[Convenção desenvolvedor/Convenção código|Convenção de Código]]

Linha 38

*[[Convenção desenvolvedor/Convenção nomes|Convenção de Nomes]]

Linha 39

*[[Convenção desenvolvedor/Teste unitário|Teste Unitário]]

Linha 40

* Log

Linha 33

Linha 34

* [[Convenção desenvolvedor/Convenção código|Convenção de Código]]

Linha 35

* [[Convenção desenvolvedor/Convenção nomes|Convenção de Nomes]]

Linha 36

* [[Convenção desenvolvedor/Teste unitário|Teste Unitário]]

Linha 37

* [[Convenção desenvolvedor/Log|Log]]

Linha 38