Dynamics 365 CRM Code Review Checklist

Guowei_Xu

407

Like ( 0 )

Report

Introduction

Code review is a critical process that involves examining source code to identify defects, improve overall code quality, and ensure compliance with internal and external standards.

It is conducted by a team of developers who collaboratively examine the codebase to catch bugs, highlight potential problems, suggest improvements, and share knowledge.

The benefits of code review are many, including increased code quality, enhanced performance, better collaboration, improved system efficiency, and professional growth for developers.

Check List

A code review checklist is a list of items that developers should consider when reviewing another person's code. The following table is a checklist for D365 CRM Development.

For a details description of each check item, please refer to the page. D365 Coding Rule

#	Check Item
1	Naming convention, using meaningful and descriptive names for variables, classes, functions, etc.
2	One Statement per Line
3	Curly braces must always be used to encapsulate compound statement code blocks
4	When using While, must keep the Loop conditions can be met. Infinite Loops must be avoided
5	User-Friendly error messages should be used, and invalid error messages should be avoided
6	Checking the Input Parameter in functions before being used
7	Remove commented-out or unused Using
8	Maintain consistent code formatting. Use the standard shortcut key CTR+K+D in VS
9	Use Early-bound and Late-bound to avoid any hard-coding
10	When building a query expression, it's important to avoid using meaningless sorting or unnecessary columns.
11	Comment block describing the functionality provided by a file should be included in all source files
12	Comments are required for complex logic, algorithms, or difficult-to-understand scenarios
13	Version Control is essential even if there is only one developer, as it helps to track changes and maintain a history of the code.
14	Check-in comments are required, it’s used to help track the change history

Please refer to this page for all the content.

This is a series of blogs introducing the Development Standards and Best Practices to help configure and customize CRM to do so consistently, clearly, and meaningfully.

Dynamics 365 CRM Development Standards and Best Practices.