ktaranov/naming-convention

Templates for naming convention - TSQL, JavaScript, C#, R, Python, Powershell

Templates for Naming Convention

There are only two hard things in Computer Science: cache invalidation and naming things -- Phil Karlton

Naming convention is a set of rules for choosing the character sequence to be used for identifiers which denote variables, types, functions, and other entities in source code and documentation.

Reasons for using a naming convention (as opposed to allowing programmers to choose any character sequence) include the following:

• To reduce the effort needed to read and understand source code;
• To enable code reviews to focus on more important issues than arguing over syntax and naming standards.
• To enable code quality review tools to focus their reporting mainly on significant issues other than syntax and style preferences.

Templates in Markdown Format

• C# Coding Standards and Naming Conventions
• Git Comment Convention
• JavaScript Name and Coding Conventions
• Powershell name convention
• R style guide and name convention
• SQL Server Name Convention and T-SQL Programming Style

Useful links and Repos for name conventions

• PEP 8 — the Style Guide for Python Code
• PHP Standards Recommendations
• NET Naming Guidelines
• Framework Design Guidelines
• Google style guides for open source projects
  • Google R Style Guide
  • Google Python Style Guide
  • Google C++ Style Guide
  • Google HTML/CSS Style Guide
  • Google Java Style Guide
  • Google JavaScript Style Guide
  • Google JSON Style Guide
  • Google Common Lisp Style Guide
  • Google Objective-C Style Guide
  • Google Shell Style Guide
  • Google Vimscript Guide
  • Google XML Document Format Style Guide
  • An AngularJS Style Guide for Closure Users at Google
• Powershell Cmdlet Development Guidelines
• Approved Verbs for PowerShell Commands
• The PowerShell Best Practices and Style Guide
• PostgreSQL naming conventions
• Lint commit messages
• Comprehensive language-agnostic guidelines on naming variables
• SEI CERT Coding Standards
  • SEI CERT C Coding Standard
  • SEI CERT C++ Coding Standard
  • SEI CERT Oracle Coding Standard for Java
  • Android Secure Coding Standard
  • SEI CERT Perl Coding Standard
  • SEI CERT Perl Coding Standard
• SQL Style Guide
• Microsoft C# Coding Conventions
• Coding Guidelines for C#
• JavaScript
  • Airbnb JavaScript Style Guide
  • Перевод «JavaScript Style Guide» от Airbnb
  • Standard ECMA-262
  • Microsoft TypeScript Coding guidelines
  • Mozilla Javascript Manual
• Sensible CSS Guidelines
• Gamemakin Unreal Engine 4 Style Guide
• Airbnb Swift Style Guide
• Awesome Naming - A curated list for when naming things
• JetBrains JSON standard for documenting web component libraries for IDEs, documentation generators and other tools
• Microsoft REST API Guidelines
• Data Import Best Practices in Power BI (by Marco Russo)
• Naming temporary columns in DAX (by Marco Russo, Alberto Ferrari)
• Python functions naming: 10 tips (by Ilya Lebedev)
• Conventional Commits
• conventional: comments - Comments that are easy to grok and grep (by Paul Slaughter)
• Google Engineering Practices Documentation

Relation Database Documentation

• SQL Server Documentation
• SQLite Documentation
• PostgreSQL Manual
• MySQL documentation

R Language

• Google R Style Guide
• R Language Definition
• Hadley Wickham R style guide
• Stackoverflow R discussion
• Bioconductor R Coding Standards
• Bioconductor R Package Guidelines
• Colin Gillespie’s R style guide
• Hadley Wickham’s R style guide

License

MIT

naming-convention's Issues

FileName/SlnName/CSprojName Standards

Hi,

I don't see you have standards for these above. Do you have a recommended standard for these or could I commit a standard that I work with?

Best,

Abhay Gupta

Suggestion for predefined type names

Point 9, "Do use predefined type names instead of system type names like Int16, Single, UInt64, etc.".

I usually use the C# aliases (predefined types) for locals, parameters and members declarations, but the Framework names when accessing the type's static members like Int32.TryParse or String.Join. Suggestion: You could add this as an exception.

C# Image Naming Convention

Is there a naming convention for images in C#?

https://github.com/ktaranov/naming-convention/blob/master/C%23%20Coding%20Standards%20and%20Naming%20Conventions.md

Question: C# Convention: Is there a convention with calling methods?

I've got a question regarding calling methods in C#. Is there a convention, too?
I.e. this function

public void DoSomething(string foo, int bar) 
{
...
}

In VS I can call this function:

DoSomething("someString", 1);

or

DoSomething(foo: "someString", bar: 1);

Is there any convention for this?

Underscores in identifiers: text/example mismatch

Point 8, "Do not use Underscores in identifiers." says: "Exception: you can prefix private static variables with an underscore", but example shows instance variable

// Exception (Class field)
private DateTime _registrationDate;

I think it would be okay to prefix fields (instance variables) with an underscore.

naming convention of Field is not accurate in C#

public field name should be PascalCase. Source
private field name should be _camelCase. Source

Invalid code: static const

In point 4 Do not use Screaming Caps for constants or readonly variables: your example uses

// Correct
public static const string ShippingType = "DropShip";

which is invalid. const implies static and is therefore neither needed, nor allowed.