Difference between revisions of "Coding standards"

From TempusServa wiki
Jump to navigation Jump to search
Line 20: Line 20:


=== Review standards ===
=== Review standards ===
The following CHANGES requires a code review
The following changes requires a formal code review
* Existing Common objects
* Changes to common objects
** Command
** Command
** Security
** Security
* New/existing Servlets
** Controller
* New/existing CodeunitPagePublic
** DbConnection
* Creation of OR changes to
* Servlets
* CodeunitPagePublic

Revision as of 11:40, 18 November 2022

Naming standards (tobe)

Package / naming placement

  • Package name all lowercase
  • General platform entities
    • Servlets
    • Fields
    • Views
  • Solution specific code

Class naming

  • Starting with uppercase
  • No special characters
  • Seperate words with uppercase

Safety standards

  • Input sanitization used in SQL, using either
    • Escape all string parameters using DbConnection.EscapeSQL
    • Prepared statements
  • Page codeunits should contain user group restrictions

Review standards

The following changes requires a formal code review

  • Changes to common objects
    • Command
    • Security
    • Controller
    • DbConnection
  • Creation of OR changes to
  • Servlets
  • CodeunitPagePublic