Qualidade e documentaçãoSeçãoOptional
Planning, testing, impact, useful comments, headers and expressive names.
HISTORICAL SOURCEPublished
Protheus Programming Manual (2001)
31 páginas · qualidade · variáveis · banco de dados · interfaces · customizaçãoReview programming principles and upgrade cautions from an AP5/TopConnect-era internal manual.
Overview
This 31-page collaborative Microsiga manual covers readability, documentation, variables, record positioning, reports, interfaces, entry points, SX dictionaries, transactions, preprocessor directives, queries, branches, referential integrity and automatic routines. Its general principles remain useful, but product names, functions and procedures require confirmation against current TDN documentation.
Syntax
31 páginas · qualidade · variáveis · banco de dados · interfaces · customizaçãoParameters
Variáveis e estadoSeçãoOptional
Declaration, initialization, scope and work-area preservation.
Dados e relatóriosSeçãoOptional
Searches, indexes, filters, branches, totals and loop safety.
CustomizaçãoSeçãoOptional
Entry points, SX dictionaries, transactions, includes and localization.
Arquitetura e integraçãoSeçãoOptional
Client/server files, TopConnect, queries, integrity and automatic routines.
Modern checklist derived from the manual
// See the Portuguese example; localize only user-facing text.Expected result
Historical principles become verifiable modern review criteria.
Safe read with environment restoration
User Function ExLeituraSegura()
Local aArea := GetArea()
DbSelectArea("SB1")
DbSetOrder(1)
If SB1->(DbSeek(xFilial("SB1") + "000001"))
ConOut(SB1->B1_DESC)
EndIf
RestArea(aArea)
ReturnExpected result
The search is checked and the caller work area is restored.
- Study the routine and its consumers before changing code.
- Document intent, rules, preconditions and impact.
- Declare and initialize variables explicitly with the narrowest suitable scope.
- Validate searches and restore received work-area state.
- Give every loop an exit condition, cursor advance and branch boundary.
- Centralize shared report and query rules.
- Use current supported mechanisms for dictionary changes.
- AP5, TopConnect, ATUSX, Quark and SourceSafe are historical context.
- Some signatures contain typographical or parameter inconsistencies.
- Historical internal functions and practices are not universal modern rules.
- Accounting, file-transfer and automation APIs vary by module and release.
- No individual author or edition is identified.