Guidelines de Implementação - Histórico de revisão

Administrador em 19h44min de 14 de setembro de 2012

2012-09-14T19:44:17Z

2009-02-20T14:46:41Z

‎'''Regra Número 1'''

2009-02-20T12:34:34Z

‎Variáveis

2009-02-20T12:34:23Z

‎Variáveis

2009-02-20T12:33:37Z

‎'''Regra Número 1'''

2009-02-20T12:11:04Z

2009-02-20T12:01:59Z

‎Comentários Iniciais

2009-02-20T12:00:39Z

‎Comentários

2009-02-20T11:54:47Z

‎Identação

2009-02-20T11:06:35Z

‎Funções e [http://pt.wikipedia.org/wiki/Método_(engenharia_de_software) Métodos]

← Edição anterior		Edição das 19h44min de 14 de setembro de 2012
Linha 1:		Linha 1:
		+	[[category:SCAE]]
	== Introdução ==		== Introdução ==
	Este documento estabelece o padrão de codificação de códigos-fonte para o projeto SCAE.		Este documento estabelece o padrão de codificação de códigos-fonte para o projeto SCAE.

@@ Linha 3: / Linha 3: @@
 == '''Regra Número 1''' ==
-Quando você não puder encontrar uma orientação ou uma regra que se aplique ao seu caso; ou ainda, quando uma regra não se aplicar, ou mais obviamente quando tudo falhar: use o '''senso comum''' e verifique os princípios fundamentais. '''Esta regra prevalece sobre todas as outras'''. O senso comum é necessário mesmo quando existem regras e orientações.
+Quando você não puder encontrar uma orientação ou uma regra que se aplique ao seu caso; ou ainda, quando uma regra não se aplicar, ou mais obviamente quando tudo falhar: use o [http://pt.wikipedia.org/wiki/Senso_comum senso comum] e verifique os princípios fundamentais. '''Esta regra prevalece sobre todas as outras'''. O senso comum é necessário mesmo quando existem regras e orientações.
 == Variáveis ==

@@ Linha 10: / Linha 10: @@
 *Todas as letras devem ser minúsculas, sendo que as palavras são separadas por underscore (_);
 *O nome da variável deverá ser o mais claro possível. Abreviações não devem ser utilizadas;
-*Nomes de variáveis globais devem ser precedidas da letra “g” em minúsculo e undercore (ex: g_line_number ).
+*Nomes de variáveis globais devem ser precedidas da letra “g” em minúsculo e underscore (ex: g_line_number ).
 == Constantes ==

@@ Linha 9: / Linha 9: @@
 *Todas as variáveis devem ser declaradas no início da função.
 *Todas as letras devem ser minúsculas, sendo que as palavras são separadas por underscore (_);
-*O nome da variável tem que ser o mais claro possível. Abreviações não devem ser utilizadas;
+*O nome da variável deverá ser o mais claro possível. Abreviações não devem ser utilizadas;
 *Nomes de variáveis globais devem ser precedidas da letra “g” em minúsculo e undercore (ex: g_line_number ).

@@ Linha 3: / Linha 3: @@
 == '''Regra Número 1''' ==
-Quando você não puder encontrar uma orientação ou uma regra que se aplique ao seu caso; ou ainda, quando uma regra não se aplicar, ou mais obviamente, ou quando tudo falhar: use o '''senso comum''' e verifique os princípios fundamentais. '''Esta regra prevalece sobre todas as outras'''. O senso comum é necessário mesmo quando existem regras e orientações.
+Quando você não puder encontrar uma orientação ou uma regra que se aplique ao seu caso; ou ainda, quando uma regra não se aplicar, ou mais obviamente quando tudo falhar: use o '''senso comum''' e verifique os princípios fundamentais. '''Esta regra prevalece sobre todas as outras'''. O senso comum é necessário mesmo quando existem regras e orientações.
 == Variáveis ==

← Edição anterior		Edição das 12h11min de 20 de fevereiro de 2009
Linha 146:		Linha 146:
	</font>		</font>
	Obs.: O termo ''Copyright (c)'' é apenas para permitir a macro substituição no código quando for definido o Tipo de Licença e ''copyright'' do mesmo.		Obs.: O termo ''Copyright (c)'' é apenas para permitir a macro substituição no código quando for definido o Tipo de Licença e ''copyright'' do mesmo.
		+
		+	== Diretórios ==
		+	A palavra toda deverá estar escrito em maiúsculo, abaixo do diretório codes.

@@ Linha 141: / Linha 141: @@
 Todos os arquivos de código fonte devem começar apenas com o comentário “Copyright (c)”, exatamente  conforme abaixo.
-     /*
+     <font color=#007A00>/*
       * Copyright (c)
       */
+</font>
 Obs.: O termo ''Copyright (c)'' é apenas para permitir a macro substituição no código quando for definido o Tipo de Licença e ''copyright'' do mesmo.

← Edição anterior		Edição das 12h00min de 20 de fevereiro de 2009
Linha 137:		Linha 137:

	Dados de alteração de código devem ser comentados em [http://www.lcad.inf.ufes.br/wiki/index.php/Releases_liberadas Releases Liberadas do SCAE] no momento em que as releases forem atualizadas no repositório.		Dados de alteração de código devem ser comentados em [http://www.lcad.inf.ufes.br/wiki/index.php/Releases_liberadas Releases Liberadas do SCAE] no momento em que as releases forem atualizadas no repositório.
		+
		+	=== Comentários Iniciais ===
		+	Todos os arquivos de código fonte devem começar apenas com o comentário “Copyright (c)”, exatamente conforme abaixo.
		+
		+	/*
		+	* Copyright (c)
		+	*/
		+
		+	Obs.: O termo ''Copyright (c)'' é apenas para permitir a macro substituição no código quando for definido o Tipo de Licença e ''copyright'' do mesmo.

@@ Linha 50: / Linha 50: @@
 *Deve-se usar a auto identação de código que acompanha a maioria das IDE’s e editores. A identação deve ser feita com o caracter <TAB>.
 *As sentenças dentro da sentença composta devem ser identadas com uma tabulação a mais.
-*Exemplos:
+Exemplos:
      '''<font color=#7A0000>void</font>'''
      some_function()
@@ Linha 64: / Linha 64: @@
+     }
 == Comentários ==

@@ Linha 30: / Linha 30: @@
 Exemplo:
-     <font color=#7A0000>void</font>
+     <font color=#7A0000>'''void'''</font>
      some_function()
+     {
@@ Linha 37: / Linha 37: @@
-     <font color=#7A0000>int</font>
+     <font color=#7A0000>'''int'''</font>
-     sum_integer(<font color=#7A0000>int</font> first_integer, <font color=#7A0000>int</font> second_integer)
+     sum_integer(<font color=#7A0000>'''int'''</font> first_integer, <font color=#7A0000>'''int'''</font> second_integer)
+     {
          ...