KEMBAR78
Coding Format Convention | PDF
Scribd
Upload
14 views2 pages

Coding Format Convention

The document outlines coding standards and best practices including naming conventions, file organization, indentation, comments, error handling, version control, and testing. It emphasizes consistency, readability, and adherence to specific language conventions for C# and JavaScript. Key points include using PascalCase for class names, camelCase for variables, and clear commit messages in version control.

Uploaded by

Nguyễn Kim Long
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as XLSX, PDF, TXT or read online on Scribd
14 views2 pages

Coding Format Convention

The document outlines coding standards and best practices including naming conventions, file organization, indentation, comments, error handling, version control, and testing. It emphasizes consistency, readability, and adherence to specific language conventions for C# and JavaScript. Key points include using PascalCase for class names, camelCase for variables, and clear commit messages in version control.

Uploaded by

Nguyễn Kim Long
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as XLSX, PDF, TXT or read online on Scribd
You are on page 1/ 2

Category Details

General PriConsistency, Readability, Simplicity, Scalability


File OrganiFile Naming: PascalCase for class files, snake_case or kebab-case for scripts; Directory Structure: Organize by featur
Naming CoVariables: camelCase; Constants: ALL_CAPS_WITH_UNDERSCORES; Classes: PascalCase; Interfaces: Prefix with I; Me
Indentatio Indentation: 4 spaces (no tabs); Braces: Same line as declaration; Spacing: Single space after keywords, blank line be
CommentsInline Comments: Sparingly for non-obvious code; Block Comments: For complex logic; Documentation Comments:
Error HandExceptions: For exceptional cases only, not flow control; Try-Catch: Use specific exceptions, avoid empty catch bloc
Version ConCommit Messages: Clear, descriptive, imperative mood; Branching Strategy: Follow a defined strategy like Gitflow
Testing an Unit Testing: For all public methods, consistent naming; Code Reviews: Focus on readability, adherence, bugs
Language-SC#: Follow .NET conventions, use 'var' for obvious types; JavaScript: Use 'const' for constants, prefer arrow function
Structure: Organize by feature or module
se; Interfaces: Prefix with I; Methods: PascalCase; Enums: PascalCase
e after keywords, blank line between methods
c; Documentation Comments: Use XML comments
ptions, avoid empty catch blocks
defined strategy like Gitflow
ability, adherence, bugs
nstants, prefer arrow functions

You might also like