Padronização das Documentações nas Unit’s

De BISAWiki

Edição atual tal como 14h18min de 5 de outubro de 2010

Observações:

• A chave e os dois asteriscos, indicam o início de um comentário de uma documentação que vai ser gerada pela BISA_DELPHI_DOC
• Dois asteriscos e a chave, encerra o bloco de documentação da UNIT
• O @ indica que no código html vai ficar em negrito ou outra formatação

{**
 Data da Atualização : 14/11/2002
 Prog. Responsável : Helcius Alves
 Última Atualização : inclusão do metodo 4;
 Necessidades Externas : Nenhuma

Metódos 1: RetornaSaldoAnterior(Bancos:TstringList;Mes,ano : string) : Currency;
 Descrição : Calcular o somatório dos saldos anterior de vários bancos;
 @parametros : Bancos : Lista dos bancos que terão seus saldos somados;
               Mes : Mês de referencia do saldo a ser somado;
               Ano : ano de referencia do saldo a ser somado;
 Retorno : Soma do saldo anterior dos bancos;
 Prog. Resp.: Helcius Alves
 Data At.: 05/11/2002

Metodo 2: RetirarPendenciaTransf(Banco1,banco2:String; TipoDoc1,TipoDoc2:String;
                               NumDoc:String; data:TdateTime) : boolean;
 Descrição : Retira a pendencia de uma transferência entre contas, temos que
             retira a pendencia na origem e no destino ;
 @parametros : Banco1, banco2 : bancos de destino e origem da transferência;
               TipoDoc1, TipoDoc2 : Tipos dos documentos
               NumDoc : Numero dos documentos
               Data : data da liberação da pendência
 Retorno : True se conseguir retirar as pendencias dos dois regristros
 Prog. Resp.: Helcius Alves
 Data At.: 08/11/2002

Metodo 3: ValorPendenciaDefault: String;
 Descrição : Retorna o Valor default para o Campo MOVI_Pendente
 @parametros : -
 Retorno : S ou N
 Prog. Resp.: Helcius Alves  
 Data At.: 14/11/2002

Metodo 4: ProximoNumeroDoc(banco,TipoDoc : string): string;
 Descrição : Retorna o Valor do proximo numero dos documentos/Cheques
 @parametros : banco : o numero do banco
               TipoDoc : o tipo de documento
 Retorno : o numero do ultimo documento + 1
 Prog. Resp.: Helcius Alves   
 Data At.: 14/11/2002
**}