SQL Scripting
- Keep all the scripts for all the tables, stored procedures, testing queries, enabling and disabling indexes and others in the Visual Studio Database Application properly. We all need to maintain the folder structure.
- Nomenclature for naming the stored procedures
- To retrieve records GetTableNameByIdSP - This is for returning only a single record, for returning more records depending upon the business logic write the simple logic name instead of ById.
- To add records AddNewTableNameSP
- To edit records UpdateTableNameSP
- To delete records DeleteTableNameSP
- The primary key created for a table should be having the key name as pk_TableName
- The foreign key created for tables should be in the format of fk_TableName_PrimaryKeyReferencingTableName
- All reserve words used in writing the scripts should always be in ALL CAPS
- Proper indentation needs to maintained in the scripts, set your system to indent the tabs by 4 spaces
- Please try to write simple comments in the script related to the business logic for anyone to understand.
C# Scripting
- Keep all variables in camel writing format
- Keep all object variable names as obj<T>
- Keep all the methods name, parameter name and data type consistent in each layer
- After creating a method in the DAL, please writer a small summary for that method - explaining what is the reason for writing this method, what are the parameters and the output.
- Have similar type of methods in code-block regions
- Apply indentation properly in all levels of the codes
- In the controllers, please follow the same pattern as the stored procedure for database handling. All controllers in the application should have a similar function name being called
HTML Scripting
- Keep the html pages formatted properly
- Write the html code in XHTML, implies that if any html tag does not have a closing tag, add /> to close this tag in the html code
When you are check-in files in the VSS please remove all commented or un-desired codes from the files. If you think its an important or useful piece of code, please enter the code in the blog.
Also as we have purchased the latest version of the Telerik RadControls, please try to read and go through documentation and client-side API. We should try to use these controls in as many ways we can. Telerik controls provides us with greater flexibility and data handling in ajax.
I will over the period of time keep updating this post by adding new points for all of us to be implementing them in our projects.
One of the most important thing that a lot of you are not following is to daily in the morning first check your official email. All tasks or bugs assigned on a project to you are emailed from the people working on the project or the client itself.