descritivo nomencaltura de programa o starsoft

7/21/2019 Descritivo Nomencaltura de Programa o StarSoft

http://slidepdf.com/reader/full/descritivo-nomencaltura-de-programa-o-starsoft 1/13

Nomenclatura das Variáveis

SSTTAARR SSOOFFTT AAPPPPLLIICCAATTIIOONNSS

Star Soft – Indústria de Software e Soluções



Descritivo Nomenclatura de Programação 2

Índice

OBJETIVO ........................................................................................ 3

Definições.......................................................................................... 3

Aplicação........................................................................................... 3

Descrição ......................................................................................... 3

Variáveis............................................................................................ 3

Nomenclaturas .................................................................................. 5

Classes.............................................................................................. 7

Funções............................................................................................. 8

Nomenclatura das tabelas............................................................ 10

Nomenclatura dos campos das tabelas........................................... 10

Selects............................................................................................. 12




Objetivo

Este documento tem por objetivo estabelecer as regras a serem observadas na

elaboração de informações enviadas ao departamento de Desenvolvimento do Star

Soft Applications, bem como a formatação da mesma.

Definições

Entende-se por Nomenclatura, o nome a ser indicado para variáveis, funções,

classes, menus e programas desenvolvidos para o Star Soft Applications.

plicação

Este documento aplica-se a todos os colaboradores da área desenvolvimento da

Indústria de Software e Soluções da Star Soft.

Descrição

Variáveis

As variáveis do Sistema, utilizadas em todos os módulos de desenvolvimento (prg,

menu, classes, forms), serão compostas por um prefixo de 3 letras maiúsculas ( a

não ser as classes), seguidos de um traço _ :

1ª letra: característica

C - classeF - função

O - objeto

P - parâmetro

S - set de classes

V - variável




2ª letra: escopo

G - global

L - local

O - objeto

P - privada

R - referência de array ou objeto

3ª letra: tipo

A - array

C - caracter

D - dataL - lógica

N - numérica

O - objeto

U – undefined

VGC_ Exemplo: variável, global, tipo caracter de nome Exemplo.

Nome: Exemplo

Variável, global, tipo caracter

VLC_UserName - Variável local do tipo caracter que armazena o nome do usuário

VLN_CurrentYear - Variável local do tipo numérica que armazena o ano atual

VPD_IssueDate- Variável privada do tipo data que armazena a data de emissão

VGL_Close - Variável pública do tipo lógica que armazena se deve fechar ou não.

PRO_Object - Parâmetro do tipo referência que armazena um objeto. Referência

significa: Um parâmetro que deve ser tratado dentro da função e no retorno dela a

função anterior vai tê-lo preenchido para tratamento.

FOC_Caption - Método de algum objeto que vai retornar uma função do tipo caracter.

FLL_Msg - Função do tipo local que emite mensagem ao usuário.




Nomenclaturas

Objetos de desenvolvimento. VGO_Gen -> Contém todas as funções genéricas do sistema..

Exemplo: VGO_Gen.FON_Msg(721) : Exibe uma mensagem.

VGO_Dat -> Contém todas as funções que manipulam dados em arquivos

remotos ou locais.

Exemplo: VGO_Dat.FOL_BeginTransaction (“B06”) : Abre uma transação

para a tabela B06.

VGO_Dat.FOL_FindExpression (“A03_UKEY”, “A03T”, “STAR SOFT”) :

Procura o cliente STAR SOFT.

VGO_Scx -> Contém todas as funções que manipulam objetos.

Exemplo: VGO_Scx.FOU_GetPropertieForm(“B06”, “caption”) : Retorna o

valor da propriedade de um form.

Devemos obedecer as seguintes regras na escrita do programa:

A) As variáveis e ou funções devem ter algum significado, preferencialmente

em inglês, sempre separadas por maiúsculas.

Exemplo: VGO_DAT.FOL_FindExpression: letras maiúsculas entre cada

palavra, sendo que o prefixo é totalmente maiúsculo.

B) Os comandos do Fox devem sempre ser escritos por inteiro em minúsculo.

Exemplo: select

substr

clear

replace

C) Funções padrões do fox: minúsculo.

Exemplo: - str(), val(), dtoc()

D) Sempre que utilizar duas comparações, use and ou or nunca utilize .or. ou

.and.




E) Palavras-chaves (if, endif,do): minúsculo.

Exemplo: if VLC_Empresa=”Star Soft”

do while .T.

enddoendif

F) Constantes genéricas: maiúsculo.

Exemplo: FRM_NORMAL

FRM_MODAL

FRM_FILTER

G) Variáveis de sistemas do Fox: maiúsculo.

Exemplo: _MLINE

_CLIPTEXT

_PAGENO

H) Nomes reservados pelo Fox: maiúsculo.

Exemplo: LOCAL

PUBLIC

PARAMETERS

LPARAMETERS

FUNCTION

ENDFUNC

I) Strings dentro de aspas duplas (“”), quando necessário aspas simples (‘’),depois colchetes ( [ ] ).

Exemplo: VLC_Empresa 1 = “Star Soft”

VLC_Empresa 2 = ‘Star Soft’

VLC_Empresa 3 = [Star Soft]

J) Variáveis lógicas sempre em maiúsculo .T. e .F.

K) Para comparações diferentes devemos usar < >.

L) Comentários:

Tabulados sempre da esquerda, obedecendo o nível a partir do sinal de

menos ( - ).

Exemplo: *-se VOL_Edit for .T.

if VOL_Edit

*-- Executa a função VGO_DAT.FOU_Execute Nothing

VGO_DAT.FOU_ExecuteNothing ()

endif




M) Nomes dos arquivos:

Em comando: maiúsculo

Exemplo: select A03

VGO_Dat.FOL_OpenTable(“A03”)

Em comando SQL: minúsculo

Exemplo: select * from a03 where a03.a03_001_c = “Star Soft”

Campos: minúsculo

Exemplo: replace a03.a03_001_c with ‘Star Soft” in A03

Ordenação: maiúsculoExemplo: select A03

set order to A03_001_C

N) Classes: minúsculo

Classes

As classes serão compostas de dois níveis:

1) Sgo_base: principal classe, sendo que é a customização das classes padrões doVFP.

2) As demais classes são as sgo_<Name>, sendo as customizações das classes do

sgo_Base,

Exemplo: sgo_textbox: contém as classes do tipo cgo_textbox dentro do

sgo_base.

3) Classes padrões do Fox: minúscula

Exemplo: thisform.a03_001_c.setfocus()

this.width = 400this caption = “Star Soft”

4) Classes customizadas: segue o padrão das variáveis

Exemplo: this.FOL_Close()

thisform.FOL_ExecuteCursor(.F.)




Funções

Devemos obedecer as seguintes regras na criação e alteração dasfunções:

1) Função : Nome da função

Exemplo: FOL_CallModalForm

2) Parâmetros : Devem ser especificados todos os parâmetros, recebidos

seguidos de comentários.

Exemplo: PLO_Form : O form que está ativo

PLO_Object : O objeto atual

3) Descrição : Especificação da função

Exemplo: Descrição : Chama um modal form do form atual

4) Retorno : O que será retornado

Exemplo: .T. – se sucesso, .F. – c.c

Função : FOL_CallModalForm

Parâmetros : PLO_form : O form que está ativado.

: PLO_object : O objeto atual.

Descrição : Chama um modal form do form atual.

Retorno : .T. - se sucesso, .F. - c.c.

Grupo : FORM

Procura por : Form, Table

Últimaalteração

: 03/11/2000

Alterado por : José da Silva

Versão : 1




1-OK, 2-Cancel, 3-Abort, 4-Retry, 5-Ignore, 6-Yes, 7-

No String alterada.

5) Grupo: Os critérios de classificação dos grupos são: onde e para que será

usada Array: Quando o foco principal do programa for manipulação de

matrizes

Cursor : Quando o foco principal do programa for manipulação de

cursores

Database: Quando o foco principal do programa for manipulação de

Banco de Dados do Fox e Tabelas. Exemplo: Gravar, Apagar,

Cancelar.

DateTime: Quando o foco principal do programa for manipulação com

datas e ou horas.

Form: Quando o foco principal for alterar valores do form ou do(s)

objeto(s).

General: Quando a função tiver várias utilidades ou não se encaixar

em nenhum outro grupo.

SQL: Quando o foco principal for manipulação com base de dadosClient Server.

6) Procura por: O objetivo da procura a função

Exemplo: Conexão

Tempo, Conversão, Segundos, Horas

Tabela, Arquivo, Procura, Seek

Abertura, Tabelas, Grupos de Arquivos

7) Última alteração: Data da ultima alteração da função.

8) Alterado por: Nome da última pessoa que alterou.

9) Versão: A medida que a função for alterada deve ser somado 1 na sua versão.




Comentários

Todos os comentários deverão iniciar por *- + comentário seguindo sua

identificação como:

*- Se o nome da empresa for Star Soft.

if VLC_CompanyName = "STAR SOFT"

*- Se o ano corrente por igual a 2000, então o bug do milênio deve ser

tratado.

if VLN_CurrentYear = 2000

endif

endif

Nomenclatura das tabelas

Todos os módulos do sistema são identificados por uma letra. Os nomes das

tabelas do sistema são compostos por uma letra que corresponde ao módulo mais

um seqüencial de dois dígitos como:

A01 : A - Módulo de cadastros gerais. 01-Cadastro de bancos.

A03 : A - Módulo de cadastros gerais. 03-Clientes.

M01 : M - Folha de Pagamento. 01-Colaboradores.

Nomenclatura dos campos das tabelas

Os campos devem ter como prefixo o nome da tabela + seqüencial de três dígitos +

o tipo de informação armazenada como:

A03_001_C - Esse é um campo que pertence a tabela A03 (clientes), é o

primeiro campo da tabela e armazena informação do tipo texto.

Todas as tabelas do sistema possuem como padrão os seguintes campos :




UKEY - Esse o campo que identifica o registro. É uma chave composto por 20

caracteres. Deverá ser criado um índice primário por esse campo.

USR_NOTE - Campo memo para comentário do registro. Poderá ser

registrado até quatro comentários por registro.

TIMESTAMP - Data/Hora da última alteração do registro. Deverá ser criado um

índice do tipo regular por esse campo.

STATUS - Contém a informação "W" de Writable que indica que esse campo já

foi gravado no banco de dados.

SQLCMD - Campo do tipo memo utilizado para geração de instrução SQL para

atualização no banco de dados.

MYCONTROL - Campo do tipo caracter de 1 posição. Deve variar entre "1" ou

"". Se "1", indica que o registro foi alterado. Então no tratamento de um cursorpara atualização no banco de dados, só serão tratados os registros que

tiverem a informação "1" gravada.

INTEGRATED - Campo caracter de 26 posições que possui "1", "" branco ou

"0" na posição da letra correspondente ao módulo que o registro foi integrado.

CIA_UKEY - Ukey da empresa que o registro foi inserido. Esse campo deverá

ter um índice do tipo regular.

Para relacionamento, deverá ser utilizado o nome da tabela relacionada + _UKEY

como sufixo. Exemplo:

Tabela J10 - Nota Fiscal de Venda.

Possui o campo A03_UKEY - Identificador da tabela de clientes

Para as tabelas de cadastro, o primeiro campo deverá ter numeração automática

deverá cadastrado no arquivo Y42. Exemplo: A01_001_C, A03_001_C,

J10_001_C, T04_001_C.

Propriedades do tipo caption, tooltip e mensagens de tela.

Todas as propriedades do tipo caption, tooltip, mensagens de tela e logs deverão

ser escritas em minúsculo em tela e cadastrado depois a tradução pelo menos em

português no arquivo Y01.




Selects

Todas as selects do sistema deverão ser escritas para os três bancos de dados:

SQL Server, Oracle e DB2. As selects devem ser escritas em maiúsculo. Todas as

tabelas remotas deverão ter como prefixo a expressão STAR_DATA@. Essa

expressão será substituída depois pelo nome do banco de dados + proprietário +

nome da tabela. Para as selects escritas em SQL, deverá ser escrito (NOLOCK)

após o nome da tabela.




As informações contidas neste documento estão sujeitas à modificação sem notificação. Nomes de

Empresas, de pessoas, endereços e dados utilizados como exemplos dentro deste documento, são

fictícios, utilizados apenas para ilustrar o potencial do produto. Nenhuma parte deste documento pode

ser reproduzida ou transmitida de nenhuma forma ou por nenhum meio eletrônico ou mecânico, por

qualquer propósito, sem a permissão expressa e escrita da Indústria de Software e Soluções – Star Soft.

Trabalho desenvolvido pela área de Capacitação e Documentação – Revisão 0 (2006).

© 2006 Indústria de Software e Soluções – Star Soft. Todos os direitos estão reservados.

Todas as marcas registradas apresentadas neste documento são de propriedade de seus fabricantes.

descritivo nomencaltura de programa o starsoft

Documents