Difference between revisions of "Coding standards"
Jump to navigation
Jump to search
| Line 3: | Line 3: | ||
* Package name all lowercase | * Package name all lowercase | ||
* General platform entities | * General platform entities | ||
** Servlets: com.tsnocode.ui | ** Servlets: '''com.tsnocode.ui''' | ||
** Fields: com.tsnocode.field | ** Fields: '''com.tsnocode.field''' | ||
** Views: com.tsnocode.views | ** Views: '''com.tsnocode.views''' | ||
* Solution specific code | * Solution specific code | ||
** TS customer app: com.tsnocode.customer.solution.app | ** TS customer app: '''com.tsnocode.customer.solution.app''' | ||
** Vendor app: com.vendor.solution.app | ** Vendor app: '''com.vendor.solution.app''' | ||
Class naming | Class naming | ||
Revision as of 10:56, 18 November 2022
Naming standards (tobe)
Package / naming placement
- Package name all lowercase
- General platform entities
- Servlets: com.tsnocode.ui
- Fields: com.tsnocode.field
- Views: com.tsnocode.views
- Solution specific code
- TS customer app: com.tsnocode.customer.solution.app
- Vendor app: com.vendor.solution.app
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
- Code containing SQL