Módulo 1: Práticas e convenções de codificação para ActionScript 2.0 (Leitura Opcional)

Aprenderemos nessa aula

Convenções de atribuição de nome, diretrizes gerais de atribuição de nome, atribuição de nomes a variáveis, atribuição de nomes a constantes, atribuição de nomes a variáveis booleanas, atribuindo nomes a funções e métodos, nomeando classes e objetos, atribuindo nomes a pacotes, atribuindo nomes a interfaces, atribuindo nomes a componentes personalizados, usando comentários no código, mantendo o código ActionScript em um único local, diretrizes para criação de uma classe, sobre inicialização, uso de instrução trace, diretrizes gerais de formatação.

Convenções de Atribuição de Nomes

Para os iniciantes em programação a legibilidade do código normalmente assume pouca importância, mas essa legibilidade é muito importante para você e principalmente para outros que eventualmente no futuro precisarem editar esse código. Pensando nisso nossa primeira aula tratará de algumas convenções a serem seguidas para atribuição de nome a diversos elementos de um código em ActionScript, ao seguir esta convenção você melhora a legibilidade de seu código (demonstrando profissionalismo), e sem perceber aumentará o fluxo do trabalho de maneira geral, permitindo a localização e correção de erros no código com mais rapidez e eficiência.

Diretrizes Gerais de Formatação em ActionScript 2.0

Recomenda-se os seguintes pontos de formatação para ajudá-lo a melhorar a legibilidade do código ActionScript.

• 1. Coloque uma linha em branco entre os parágrafos (módulos) do ActionScript. Os parágrafos do código ActionScript são grupos de código relacionado logicamente. A inclusão de uma linha em branco entre eles ajuda os usuários a ler o código ActionScript e a entender sua lógica.
• 2. Use recuos consistentes no código para ajudar a mostrar a hierarquia da estrutura do código. Use o mesmo estilo de recuo em todo o código ActionScript e alinhe as chaves ({}) adequadamente. Chaves alinhadas melhoram a legibilidade do código. Se a sintaxe do ActionScript estiver correta, o Flash recuará automaticamente o código de forma correta quando você pressionar Enter (Windows) ou Return (Macintosh). Você também pode clicar no botão Auto Format (Formatação automática) no editor do ActionScript (o painel Actions ou a janela Script) para recuar o código ActionScript se a sintaxe estiver correta.
• 3. Use quebras de linha para facilitar a leitura de instruções complexas.
• 4. Você pode formatar algumas instruções, como as condicionais, de várias maneiras. Às vezes, a formatação das instruções em várias linhas, em vez de em uma única, facilita a leitura do código.
• 5. Inclua um espaço após uma palavra-chave seguida por parênteses [()]. O código ActionScript a seguir mostra um exemplo disso:

do {
// código a ser executado
} while (condition);

• 6. Não coloque um espaço entre o nome de um método e os parênteses. O código ActionScript a seguir mostra um exemplo disso:

function checkLogin():Boolean {
// declarações;
}
checkLogin();
ou
printSize("O tamanho é " + variavelTamanho + "\n");

• 7. Coloque um espaço depois das vírgulas em uma lista de argumentos. O uso de espaços depois de vírgulas facilita a distinção entre as chamadas de métodos e as palavras-chave, como mostra o exemplo a seguir:

function addItems(item1:Number, item2:Number):Number {
return (item1 + item2);
}
var sum:Number = addItems(1, 3);

• 8. Use espaços para separar todos os operadores e seus operandos. O uso de espaços facilita a distinção entre as chamadas de métodos e as palavras-chave, como mostra o exemplo a seguir:

//desejável
var sum:Number = 7 + 3;
//indesejável
var sum:Number=7+3;

• 9. Uma exceção a essa diretriz e o operador ponto (.).
• 10. Não coloque espaços entre operadores unários e seus operandos.
• 11. Não coloque espaços após um parêntese de abertura e antes de um parêntese de fechamento. O código ActionScript a seguir mostra um exemplo disso:

// indesejável
( "O tamanho é  " + variavelTamanho + "\n" );
//desejável
("O tamanho é  " + variavelTamanho + "\n");

• 12. Coloque cada instrução em uma linha separada para aumentar a legibilidade do código ActionScript. O código ActionScript a seguir mostra um exemplo disso:

oNum++; // correto
oOutroNum++; // correto
umNum++; umOutroNum++; // incorreto

• 13. Atribua variáveis como instruções separadas.
• 14.  Alinhe a segunda linha com o início da expressão na linha de código anterior.

Clique no logo do Flash para ler mais...