Aviso: Este artigo ainda é um rascunho!

 Programação

Introdução

Neste artigo estão disponíveis as definições pertinentes à padronização dos projetos desenvolvidos em Fox versão X.0. Para evitar retrabalho procurou-se manter as definições que já constavam quando não implicava em erro. Por estar embasada na experiência e em pareceres técnicos, esta documentação busca ser o mais abrangente possível, associando-se estabilidade a técnicas de documentação e atualização inteligentes. Este modelo serve para facilitar e padronizar o desenvolvimento do CheckOut.

Usabilidade

Resolução

Os formulários do sistema são construídos para a resolução XXX x XXX pixels (descontando-se a área ocupada pelos objetos da MDI), salvo no caso de formulários modais, que se restringem a 640 x 480 pixels (em razão de não haver paginação).

Fontes

Exceto os casos previstos no decorrer deste documento, o fonte utilizado em todos os objetos é Verdana, de tamanho 9, normal (sem efeitos, ex. itálico), e também sem efeitos 3D. Para os sub-títulos das telas a fonte deve ser em negrito e alinhados a esquerda. Os títulos das guias devem ser em negrito com alinhamento centralizado.

Cores

Todos os objetos devem obedecer ao padrão de cores ????????. As imagens existentes nos sistemas podem conter até 16 milhões de possibilidades de cores. Imagens devem ter, como cor de fundo, ?????? (RGB = 255, 0, 255). Essa cor não está sujeita a distorções. Com barras de botões (ocxButtonBar), o efeito é automático, desde que a cor de fundo seja vbMagenta.

Imagens

Todas as imagens para botões devem ter um dos seguintes tamanhos: a) 16 x 16 pixels a 19 x 19 pixels (para a barra de botões); b) 12 x 12 pixels (quando estiverem em botões posicionados rente a um TextBox).

Todas as imagens devem ser armazenadas http://????????. Jamais deverá ser alterada ou excluída qualquer imagem que esteja no repositório.

Relatórios

Portabilidade

Nomenclatura

Projetos

Os projetos são denominados logicamente com o prefixo prj. O nome do projeto será o nome do módulo que representa, sem qualquer tipo de acentuação ou cedilha: prjAgendamento, prjRelatorios, prjRotinasAnuais. O módulo principal do sistema tem o nome prjPrincipal.

Classes

A classe principal do sistema é a totali.vcx, entretanto, o modo visual de criação de classe foi descontinuado.

Novas classes devem ser criadas de forma dinâmica no tlclass.prg, seguindo o paradigma da orientação a objetos, conforme exemplo:

Define Class Vendas As Collection OlePublic Procedure Adicionar Lparameters loVenda This.Add(loVenda) Endproc

Procedure Imprimir
	For X = 1 To This.Count
		This.Item\[X\].ImprimirNfe()
	Endfor
Endproc	

Enddefine

Se for necessária a criação de um nova classe, deve ter no nome o prefixo cls. Exemplo: clsVenda.prg

Propriedades, Métodos e Eventos

As propriedades, métodos e eventos não devem possuir prefixo e sufixo. O nome das Propriedades, Métodos e Eventos das classes deverão conter a idéia que os representa, sem qualquer tipo de acentuação ou cedilha: RetornaNomePessoa(), NomePessoa, AlterarNomePessoa()

MDIs

As MDIs sempre serão denominadas logicamente mdiPrincipal.

Formulários

Os formulários são denominados logicamente com o prefixo frm. O nome do formulário deve conter a idéia que representa, sem qualquer tipo de acentuação ou cedilha: frmUsuario, frmEventos, frmConfiguracaoRelatorios.

Controles

Os controles abaixo são denominados logicamente com os prefixos definidos abaixo:

Componente	Prefixo
CheckBox	Chk
ComboBox	cbo
CommandButton	cmd
Data	dat
Frame	fra
Grid	gr

Procedures e funções globais

Todas as procedures globais e as funções globais devem ser denominadas logicamente com o prefixo sup. Não deve haver nenhum tipo de acentuação ou cedilha no nome.

Variáveis globais

Todas as variáveis globais devem ser denominadas logicamente com o prefixo glb. Não deve haver nenhum tipo de acentuação ou cedilha no nome.

Variáveis globais ao formulário, ao módulo e à classe

Todas as variáveis globais ao formulário devem ser denominadas logicamente com o prefixo glf. Não deve haver nenhum tipo de acentuação ou cedilha no nome.

Procedures locais

Todas as procedures locais devem ser denominadas logicamente com o prefixo sub. Não deve haver nenhum tipo de acentuação ou cedilha no nome.

Funções locais

Todas as funções locais devem ser denominadas logicamente com o prefixo fun. Não deve haver nenhum tipo de acentuação ou cedilha no nome.

Procedimentos e Funções publicas de classes

Todas os procedimentos e funções públicas de classes não devem conter prefixo. Não deve haver nenhum tipo de acentuação ou cedilha no nome.

Variáveis locais

Todas as variáveis locais devem ser denominadas logicamente com o prefixo loc. Não deve haver nenhum tipo de acentuação ou cedilha no nome.

Constantes

As constantes devem estar em maiúsculas. Não deve haver nenhum tipo de acentuação ou cedilha no nome.

Aspectos Linguísticos

Para fins de definição deve-se observar os seguintes critérios:

1. Quando o termo a ser utilizado se refere a uma entidade. Ex.: Nomes de Telas (Labels), itens de menu, títulos de objetos em geral levará a primeira letra maiúscula a preposição/conjunção minúsculas e a segunda palavra com a primeira letra maiúscula. Exemplos: Cupom Fiscal, Abertura de Caixa.

2. Quando o termo a ser utilizado se refere a uma entidade. Ex.: Nomes de campos (Labels), observação em objetos em geral levará a primeira letra maiúscula e as demais minúsculas. Exemplos: Valor, Valor do item.

3. Todas os artigos, conjunções e preposições serão em letras minúsculas:

a. Artigos: o, a, os, as, um, uma, uns, umas. b. Preposições (e suas contrações com artigos): a, ao, à, aos, às, até, com, de, do, da, dos, das, desde, para, por, pelo, pela, pelos, pelas, sob, etc. c. Conjunções: que, como, se, etc. Exemplos:Descrição do produto

4. Nomes de campos não devem ser negritos e nem itálico.

5. As preposições e os artigos não devem ser omitidos, como nestes exemplos errôneos: “Transferência Valores”. O correto é sempre escrever por completo, ou seja, "Transferência de Valores".

6. Siglas devem ser escritas de acordo com as seguintes regras:

• Use todas as letras maiúsculas: se a sigla tiver até três letras : ONU, OEA,CEF, MEC, USP, CEB, PM e se todas a letras forem pronunciadas : BNDES, GDF, PMDB, INSS, CNBB, PSDB;

• Se a sigla tiver mais de 3 letras: Só a inicial é maiúscula: Aids, Embrapa, Detran, Caesb, Unesco, Opep, Otan, Serpro.

• Em casos específicos, utilizar a sigla de acordo com a grafia utilizada pela entidade ou objeto a que se refere. Exemplo: CNPq, NF-e

7. Não se deve abreviar palavras. No entanto, quando for inevitável (falta de espaço em formulário ou relatórios) dever-se-á observar as seguintes regras:

• A regra geral é escrever a primeira sílaba e a primeira letra da segunda sílaba, seguidas de ponto abreviativo.

• Caso a primeira letra da segunda sílaba seja vogal, escreve-se até a consoante. Exemplos: fut. (futuro), adj. (adjetivo), gram. (gramática), num. (numeral), al. (alemão), subst. (substantivo).

• Se a palavra tiver acento gráfico, este será conservado se cair na primeira sílaba. Exemplos: núm. (número), gên. (gênero), créd. (crédito), déb. (débito), lóg. (lógica), méd. (médico).

• Se a segunda sílaba iniciar por duas consoantes, as duas farão parte da abreviatura. Exemplos: pess. (pessoa), constr. (construção), secr. (secretário), diss. (dissílabo).

• Algumas palavras não seguem a regra geral para abreviatura. Exemplos: a.C. ou A.C. (antes de Cristo), ap. ou apto. (apartamento), bel. (bacharel), btl. (batalhão), cel. (coronel), Cia. (Companhia), cx. (caixa), D. ( digno, Dom, Dona), f. ou fl. ou fol. (folha), ib. ou ibid. (ibidem, da mesma forma), id. (idem, o mesmo), i.é. (isto é), Ilmo. (Ilustríssimo), Ltda. (Limitada), M.D. (Muito Digno), p. ou pág. (página), pp. Págs. (páginas), pg. (pago), p.p. (próximo passado), P.S. (pós escrito = escrito depois), Q.G. (Quartel General), rem. ou remte. (remetente), S.A. (Sociedade Anônima), sv. (serviço), S.O.S. (Save Our Souls = salvai nossas almas), u.i. (uso interno), U.S.A. (Unitid States of América = Estados Unidos), vv. (versos, versículos).

• Nas abreviaturas de caráter internacional, não se põe o ponto abreviativo: h, kg, km, kw, l.

• Nunca corte a palavra numa vogal, sempre numa consoante.

• A abreviatura deve ter metade ou menos da metade da palavra original, do contrário, será melhor escrever a palavra por extenso.

8. Nomes das colunas na grid deverão estar com a primeira em maiúscula e as demais minúsculas: Valor unitário; Quantidade; Valor total do item;

9.O padrão para label é Fonte: Verdana; Tamanho: 9.

10. Os sub-títulos das telas devem estar em negrito e alinhados a esquerda. Fonte Verdana; Tamanho: 9.

11. Os títulos das guias estão em negrito com alinhamento centralizado. Fonte Verdana; Tamanho: 9.

Licença de Uso

==Propriedades==