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. | ** Servlets: '''com.tsnocode.servlet''' | ||
** Fields: '''com.tsnocode.field''' | ** Fields: '''com.tsnocode.field.TYPE''' | ||
** Views: '''com.tsnocode.views''' | ** Views: '''com.tsnocode.views''' | ||
* Solution specific code | * Solution specific code | ||
Revision as of 11:20, 18 November 2022
Naming standards (tobe)
Package / naming placement
- Package name all lowercase
- General platform entities
- Servlets: com.tsnocode.servlet
- Fields: com.tsnocode.field.TYPE
- Views: com.tsnocode.views
- Solution specific code
- TS customer app:
- com.tsnocode.solution.app
- com.tsnocode.solution.customer
- com.tsnocode.solution.customer.app
- Vendor app:
- com.vendor.tsnocode.app
- com.vendor.solution.app
- TS customer app:
Class naming
Naming convention follows Java standard
- Starting with uppercase
- No special characters
- Seperate words with uppercase
In addition the following are recommended
- CodeunitPage post fix name "Page"
- CodeunitService post fix name "Service"
- Shared ressources include "Helper"
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 the API
- Changes to common objects
- Command
- Security
- Controller
- DbConnection
- Creation of OR changes to
- Servlets
- CodeunitPagePublic
- Code containing SQL