1C: Enterprise 8.2 /
Para desenvolvedores /
Convenções de Código

Tabela de conteúdos

1.1. No módulo de programa (módulos gerais, módulos de objetos, módulos de gerenciadores de objetos, módulos de formulários, comandos, etc.) no caso geral, as seguintes seções podem estar presentes nas seguintes seqüências :

Algumas seções podem estar presentes apenas em módulos de um determinado tipo. Por exemplo, manipuladores de eventos para elementos de formulário podem estar presentes apenas em módulos de formulário, e a seção de descrição de variável e seção de inicialização não podem ser definidos em módulos gerais não globais, módulos de gerenciador de objetos, conjuntos de registros, valores constantes e módulo de sessão.

O requisito de dividir o código do módulo em seções destina-se a aumentar a legibilidade do código e simplificar a introdução de alterações no código por diferentes autores ( pelos desenvolvedores ) como no desenvolvimento coletivo, e no refinamento de soluções de aplicação para implementações específicas.

1.2. Seções de modelo (em branco para cópia) para módulos comuns:

////////////////////////////////////////////////// ////////////////////////////// // // // //////////// ////////////////////////////////////////////////// ////////////// //////////////////////////////////// //////////////////////////////////////////// // // INTERFACE DE SOFTWARE // ////////////////////////////////////////////////// //////////////////////////// // PROCEDIMENTOS DE SERVIÇO E FUNÇÕES

• A seção "Interface do programa" contém procedimentos e funções de exportação destinados ao uso por outros objetos de configuração ou outros programas (por exemplo, por meio de uma conexão externa).
• A seção "Procedimentos e funções utilitários" contém os procedimentos e funções que compõem a implementação interna de um módulo comum. Nos casos em que o módulo comum faz parte de alguns funcional subsistemas que incluem vários objetos de metadados, essa seção também pode conter procedimentos e funções de exportação de serviços destinados apenas a serem chamados de outros objetos desse subsistema.
  Para módulos comuns em massa, recomenda-se dividir esta seção em subseções, de acordo com o atributo funcional. Subseções são precedidas por um comentário, que é recomendado para emitir de maneira semelhante. Por exemplo:

////////////////////////////////////////////////// ////////////////////////////// // Atualização da base de informações

1.3. Modelo para o design de seções para módulos de objetos, gerenciadores, conjuntos de registros, tratamentos, relatórios, etc.

////////////////////////////////////////////////// ////////////////////////////// // INTERFACE DE SOFTWARE ////////////// // ////////////////////////////////////////////////// ////////////// // PROCESSORES DE EVENTOS //////////////////////////////// //////////////////////////////////////////////// // // PROCEDIMENTOS DE SERVIÇO E FUNÇÕES

• A seção "Interface do Programa" contém procedimentos e funções de exportação destinados a uso em outros módulos de configuração ou outros programas (por exemplo, através de uma conexão externa). Não é necessário colocar nesta seção funções e procedimentos de exportação que se destinam a ser chamados apenas dos módulos do próprio objeto, seus formulários e comandos. Por exemplo, os procedimentos para preencher a parte da tabela de um documento que são chamados do processamento de preenchimento no módulo de objeto e do formulário de documento no manipulador de comando de formulário não são a interface do programa do módulo de objeto, uma vez que são chamados apenas no próprio módulo e nas formas do mesmo objeto. Eles devem ser colocados na seção "Procedimentos e funções utilitárias."
• A seção "Manipuladores de Eventos" contém manipuladores de eventos para o módulo do objeto ( Prizavisi , PRO , etc.)
• A seção "Procedimentos Utilitários e Funções" tem o mesmo propósito dos módulos gerais.

1.4. Modelo de design de seção para módulos de formulário:

////////////////////////////////////////////////// ////////////////////////////// // MANIPULADOR DE EVENTOS DO FORMULÁRIO ///////////// ////////////////////////////////////////////////// /////////////// // HANDLERS DE EVENTOS DE ELEMENTOS DA FORMA DO FORMULÁRIO //////////////////////////// ////////////////////////////////////////////////// // // PROCESSORES DE EVENTOS FORMS TABLES ////////////////////////////////////////// ////////////////////////////////////// // PROCESSADORES PARA AS EQUIPES DO FORMULÁRIO /////// ////////////////////////////////////////////////// /////////////////////// // PROCEDIMENTOS DE SERVIÇO E FUNÇÕES

• A seção “Manipuladores de evento de formulário” contém os procedimentos do manipulador de eventos de formulário: Em Criando um Servidor , Abertura , etc.
• A seção "Manipuladores de elementos de formulário" contém procedimentos para processar elementos localizados na parte principal do formulário (tudo o que não está relacionado às tabelas no formulário).
• Nas seções “Manipuladores de eventos da tabela de formulários <nome da tabela de formulários>”, há procedimentos para os manipuladores da tabela de formulários e dos elementos da tabela. Para procedimentos do manipulador, cada tabela deve ter sua própria partição.
• A seção “Manipuladores de comando de formulário” contém procedimentos para manipuladores de comando de formulário (cujos nomes são especificados na propriedade Action dos comandos de formulário).
• A seção "Procedimentos Utilitários e Funções" tem o mesmo propósito dos módulos gerais.

Veja também: Regras para criar módulos de formulário

2. Requisitos gerais para seções de módulos de software.

2.1. O cabeçalho do módulo é um comentário no início do módulo. O título do módulo fornece uma breve descrição e condições de aplicação.
Por exemplo:

////////////////////////////////////////////////// //////////////////////////// // // Procedimentos e funções do cliente de finalidade geral: // - para trabalhar com listas em formulários; // - para trabalhar com o log; // - para processar ações utilizador em andamento editando // multiline texto por exemplo, comentários em documentos; // - outro. // //////////////////////////////////////////////// ////////////////////////////////

Para módulos de formulário, é recomendável colocar uma descrição dos parâmetros de formulário no cabeçalho.

2.2. Seção de descrição variável . Os nomes das variáveis ​​são atribuídos de acordo com o regras de nome de variável e seu uso é descrito no artigo. Usando variáveis ​​globais em módulos de software .

Todas as variáveis ​​do módulo devem receber um comentário suficiente para entender seu propósito. Recomenda-se que o comentário seja colocado na mesma linha em que a variável é declarada.
Exemplo:

Pem CurrencyAccounting Export; // Moeda em que a contabilidade é mantida Perem Address Supports Export; // Endereço de e-mail para o qual as mensagens de erro são enviadas

2.3. Interface de software Os procedimentos e funções de exportação que compõem sua interface de programação são colocados imediatamente após a descrição das variáveis. Tais procedimentos e funções são destinados ao uso por outros objetos de configuração ou outros programas (por exemplo, através de uma conexão externa), portanto devem estar localizados em um “lugar visível” no módulo.

Veja também: Descrição de procedimentos e funções.

2.4.1 Manipuladores de eventos de formulário, comandos e elementos de formulário . Antes dos procedimentos e funções de serviço no módulo de formulário, localizam-se manipuladores de eventos do formulário, bem como manipuladores de eventos para comandos e elementos de formulário.

Recomendação metódica (conselho útil)

Recomenda-se que os manipuladores de um elemento de formulário sejam colocados juntos, seguindo a ordem de seus seguidores no painel de propriedades do editor de formulários. no configurador .

2.4.2. Cada evento deve ter seu próprio procedimento de manipulador. Se as mesmas ações devem ser executadas quando os eventos ocorrerem em diferentes elementos do formulário:

• criar um procedimento separado (função) que executa as ações necessárias

• para cada elemento do formulário, crie um manipulador separado com o nome padrão

• chame o procedimento necessário (função) de cada manipulador.

Por exemplo, errado:

& Procedimento OnClient para Parâmetros de Seleção de ExecutingApplication (Element) = New Compliance (); Seleção de Opções Colar ("Por Autor", Por Autor); Seleção de Opções: Colar ("Executivo", Executivo); Definir seleção de lista (lista, opções de seleção); EndProcedure & No Procedimento do Cliente para Autoração Alterando (Elemento) Para Executivo Alterando (Indefinido); EndProcedure

correto:

& Procedimento OnClient para PerformIndicator (Item) SetSelection (); Finalizar Procedimento & No Cliente Procedimento Por Autor Alterar (Elemento) Instalar Seleção (); EndProcedures & OnServer Procedure SetSelection () Parâmetros de seleção = New Compliance (); Seleção de Opções Colar ("Por Autor", Por Autor); Seleção de Opções: Colar ("Executivo", Executivo); Definir seleção de lista (lista, opções de seleção); EndProcedure

Esse requisito é devido ao fato de que a lógica dos procedimentos do manipulador de eventos não se destina a uso no código do módulo, mas é chamada diretamente pela plataforma. Misturar esses dois cenários em um procedimento desnecessariamente complica sua lógica e reduz sua robustez (em vez do cenário de chamada previsto - em um evento da plataforma - o código do procedimento deve contar com outras chamadas diretas do código).

2.5. Os manipuladores de eventos para os módulos de objeto e o gerenciador de objetos são colocados após a exportação, mas antes dos procedimentos do utilitário e das funções do módulo.

Recomendação metódica (conselho útil)

Recomenda-se colocar os manipuladores, seguindo a ordem de seus seguidores na descrição do idioma incorporado.

2.6. Procedimentos de utilitários e funções de módulo que não são manipuladores de eventos, mas constituem a implementação interna de um módulo, são colocados no módulo ao lado de manipuladores de eventos.

Nos casos em que um módulo comum faz parte de um subsistema funcional que inclui vários objetos de metadados, essa seção também pode conter procedimentos e funções de exportação de serviço destinados apenas a serem chamados de outros objetos desse subsistema.

Recomenda-se que os procedimentos e funções relacionados uns aos outros por natureza ou lógica de trabalho sejam colocados juntos. Não é recomendado agrupar explicitamente os procedimentos e funções do módulo em servidor, cliente e funções sem contexto, uma vez que tal ordenação “tecnológica” complica a compreensão da lógica do módulo, desviando a atenção do desenvolvedor para os detalhes de sua implementação.

2.7. A seção de inicialização contém instruções que inicializam as variáveis ​​do módulo ou objeto (formulário). Por exemplo:

Endereço de suporte = "[email protected]"; // Endereço para entrar em contato com o suporte técnico Executar inicialização ();

Outros materiais sobre o tema:
banco de dados de atualização , manipuladores de eventos , interface de software , manipuladores , procedimentos , padrão , manchete , fim do procedimento , funções , interface , descrição , prancheta , para copiar , seção , troca , formulários , um objeto , o elemento , configurando , configurações , documento

Materiais da seção: 1C: Enterprise 8.2 / Developers / Agreements ao escrever código

Outros materiais sobre o tema:

Descrição dos procedimentos e funções

Recursos de dimensionamento para o objeto selecionado

Transferência de configurações na plataforma 1C: Enterprise 8.2 para a plataforma 1C: Enterprise 8.3 sem o modo de compatibilidade com a versão 8.2

Nomes de procedimentos e funções

Usando o modo privilegiado

Encontramos: a estrutura do módulo 1c é , procedimentos e funções de serviço , módulo, procedimento de chamada do módulo gerenciador 1c 8 2, como chamar um procedimento de outro módulo 1c, cabeçalho do módulo de inglês, 1c de um procedimento de processamento, 1c 8 2 chamar um procedimento do módulo gerenciador, 1