| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
Below is a list of coding practices for this project in no necessary order:
The proper way to use brackets { } is to put them on the next new line not next to the statement.
INCORRECT
for (int i = 0; i < 5; i++) {
// code }
CORRECT
for (int i = 0; i < 5; i++)
{
// code
}
Function naming should use Pascal case. Camel case and snake case are not accepted.
CORRECT
public static void GetDir (object param1)
{
// CODE
}
INCORRECT
public static void getDir (object param1)
{
// CODE
}
INCORRECT
public static void get_dir (object param1)
{
// CODE
}
Comment code as often as necessary to clarify what functions or code blocks do. More specifically, place a summary comment before the name of the class to explain its purpose and include any developer notes and TODOs. Try to avoid placing large notes and TODOs in the code itself unless it is required for clarity.
EXAMPLES
/// <summary>
/// Create or update a table in the database
/// </summary>
/// <param name="tablename>Name of the table to be updated</param>
public static bool CreateUpdateTable(string tablename)
{
// First, we check if the table exists
...
// If it does, update the table
...
// If it doesn't, create the table
...
// TODO: Extract this later
...
}
| Back | FazBrowse Home | New Git URL |