mirror of
https://github.com/Stone-Red-Code/naming-convention.git
synced 2026-09-04 09:06:19 +02:00
Patrick Hintermayer
096126c0d2
SQL Style Guide by the project https://github.com/treffynnon/sqlstyle.guide
123 lines
7.6 KiB
Markdown
123 lines
7.6 KiB
Markdown
# Templates for Naming Convention
|
||
[![licence badge]][licence]
|
||
[![stars badge]][stars]
|
||
[![forks badge]][forks]
|
||
[![issues badge]][issues]
|
||
[![contributors_badge]][contributors]
|
||
|
||
[licence badge]:https://img.shields.io/badge/license-MIT-blue.svg
|
||
[stars badge]:https://img.shields.io/github/stars/ktaranov/naming-convention.svg
|
||
[forks badge]:https://img.shields.io/github/forks/ktaranov/naming-convention.svg
|
||
[issues badge]:https://img.shields.io/github/issues/ktaranov/naming-convention.svg
|
||
[contributors_badge]:https://img.shields.io/github/contributors/ktaranov/naming-convention.svg
|
||
|
||
[licence]:https://github.com/ktaranov/naming-convention/blob/master/LICENSE.md
|
||
[stars]:https://github.com/ktaranov/naming-convention/stargazers
|
||
[forks]:https://github.com/ktaranov/naming-convention/network
|
||
[issues]:https://github.com/ktaranov/naming-convention/issues
|
||
[contributors]:https://github.com/ktaranov/naming-convention/graphs/contributors
|
||
|
||
> There are only two hard things in Computer Science: cache invalidation and naming things
|
||
> -- <cite>[Phil Karlton](https://www.karlton.org/2017/12/naming-things-hard/)</cite>
|
||
|
||
[Naming convention][99] 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.
|
||
|
||
[99]:https://en.wikipedia.org/wiki/Naming_convention_(programming)
|
||
|
||
|
||
## Templates in Markdown Format
|
||
- [C# Coding Standards and Naming Conventions](C%23%20Coding%20Standards%20and%20Naming%20Conventions.md)
|
||
- [Git Comment Convention](Git%20Comment%20Convention.md)
|
||
- [JavaScript Name and Coding Conventions](JavaScript%20Name%20and%20Coding%20Conventions.md)
|
||
- [Powershell name convention](Powershell.md)
|
||
- [R style guide and name convention](R%20style%20uide%20and%20name%20convention.md)
|
||
- [SQL Server Name Convention and T-SQL Programming Style](SQL%20Server%20Name%20Convention%20and%20T-SQL%20Programming%20Style.md)
|
||
|
||
|
||
## Useful links for name conventions
|
||
- [PEP 8 — the Style Guide for Python Code](https://pep8.org/)
|
||
- [PHP Standards Recommendations](https://www.php-fig.org/psr/)
|
||
- [NET Naming Guidelines][1]
|
||
- [Framework Design Guidelines][2]
|
||
- [Google style guides for open source projects](https://github.com/google/styleguide)
|
||
- [Google R Style Guide][3]
|
||
- [Google Python Style Guide][4]
|
||
- [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html)
|
||
- [Google HTML/CSS Style Guide](https://google.github.io/styleguide/htmlcssguide.html)
|
||
- [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html)
|
||
- [Google JavaScript Style Guide](https://google.github.io/styleguide/jsguide.html)
|
||
- [Google JSON Style Guide](https://google.github.io/styleguide/jsoncstyleguide.xml)
|
||
- [Google Common Lisp Style Guide](https://google.github.io/styleguide/lispguide.xml)
|
||
- [Google Objective-C Style Guide](https://github.com/google/styleguide/blob/gh-pages/objcguide.md)
|
||
- [Google Shell Style Guide](https://google.github.io/styleguide/shell.xml)
|
||
- [Google Vimscript Guide](https://google.github.io/styleguide/vimscriptfull.xml)
|
||
- [Google XML Document Format Style Guide](https://google.github.io/styleguide/xmlstyle.html)
|
||
- [An AngularJS Style Guide for Closure Users at Google](https://google.github.io/styleguide/angularjs-google-style.html)
|
||
- [MSDN Powershell Style Guide][5]
|
||
- [MSDN Approved Verbs for Windows PowerShellCommands][6]
|
||
- [The PowerShell Best Practices and Style Guide](https://github.com/PoshCode/PowerShellPracticeAndStyle)
|
||
- [PostgreSQL naming conventions](https://stackoverflow.com/q/2878248/2298061)
|
||
- [Lint commit messages](https://github.com/conventional-changelog/commitlint)
|
||
- [Comprehensive language-agnostic guidelines on naming variables](https://github.com/kettanaito/naming-cheatsheet)
|
||
- [SEI CERT Coding Standards](https://wiki.sei.cmu.edu/confluence/display/HOME)
|
||
- [SEI CERT C Coding Standard](https://wiki.sei.cmu.edu/confluence/display/c/SEI+CERT+C+Coding+Standard)
|
||
- [SEI CERT C++ Coding Standard](https://wiki.sei.cmu.edu/confluence/pages/viewpage.action?pageId=88046682)
|
||
- [SEI CERT Oracle Coding Standard for Java](https://wiki.sei.cmu.edu/confluence/display/java/SEI+CERT+Oracle+Coding+Standard+for+Java)
|
||
- [Android Secure Coding Standard](https://wiki.sei.cmu.edu/confluence/display/android/Android+Secure+Coding+Standard)
|
||
- [SEI CERT Perl Coding Standard](https://wiki.sei.cmu.edu/confluence/display/perl/SEI+CERT+Perl+Coding+Standard)
|
||
- [SEI CERT Perl Coding Standard](https://wiki.sei.cmu.edu/confluence/display/perl/SEI+CERT+Perl+Coding+Standard)
|
||
- [SQL Style Guide](https://www.sqlstyle.guide)
|
||
|
||
|
||
## Relation Database Documentation
|
||
- [SQL Server Documentation](https://docs.microsoft.com/sql/sql-server/sql-server-technical-documentation)
|
||
- [SQLite Documentation](https://www.sqlite.org/docs.html)
|
||
- [PostgreSQL Manual](http://www.postgresql.org/docs/current/static/)
|
||
- [Oracle DB documentation](https://docs.oracle.com/en/database/database.html)
|
||
- [MySQL documentation](http://docs.oracle.com/cd/E17952_01/index.html)
|
||
|
||
|
||
## Different Languages Style Guides
|
||
- C# Language ([C# Programming Guide])
|
||
- JavaScript
|
||
- [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript)
|
||
- [Перевод «JavaScript Style Guide» от Airbnb](https://github.com/leonidlebedev/javascript-airbnb)
|
||
- [Standard ECMA-262](http://www.ecma-international.org/publications/standards/Ecma-262.htm)
|
||
- [Microsoft TypeScript Coding guidelines](https://github.com/Microsoft/TypeScript/wiki/Coding-guidelines)
|
||
- [Mozilla Javascript Manual](https://developer.mozilla.org/en-US/docs/Web/JavaScript)
|
||
- [Sensible CSS Guidelines](https://github.com/chris-pearce/css-guidelines)
|
||
- R Language ([R Language Definition])
|
||
- Transact-SQL ([T-SQL Reference])
|
||
- Procedural Language/PostGres Structured Query Language ([PL/pgSQL Manual])
|
||
- [Python PEP](https://www.python.org/dev/peps/)
|
||
|
||
|
||
## R Language
|
||
- [Google R Style Guide][3]
|
||
- [Hadley Wickham R style guide](http://r-pkgs.had.co.nz/style.html)
|
||
- [Stackoverflow R discussion](http://stackoverflow.com/questions/10013545/are-there-any-official-naming-conventions-for-r)
|
||
- [Bioconductor R Coding Standards](http://bioconductor.org/developers/how-to/coding-style/)
|
||
- [Bioconductor R Package Guidelines](http://bioconductor.org/developers/package-guidelines/)
|
||
- [Colin Gillespie’s R style guide](http://csgillespie.wordpress.com/2010/11/23/r-style-guide/)
|
||
- [Hadley Wickham’s R style guide](http://stat405.had.co.nz/r-style.html)
|
||
|
||
## License
|
||
[MIT](/LICENSE)
|
||
|
||
[1]:https://docs.microsoft.com/en-us/dotnet/standard/design-guidelines/naming-guidelines
|
||
[2]:https://docs.microsoft.com/en-us/dotnet/standard/design-guidelines
|
||
[3]:https://google.github.io/styleguide/Rguide.xml
|
||
[4]:https://github.com/google/styleguide/blob/gh-pages/pyguide.md
|
||
[5]:http://msdn.microsoft.com/en-us/library/dd878270%28v=vs.85%29.aspx
|
||
[6]:http://msdn.microsoft.com/en-us/library/ms714428%28v=vs.85%29.aspx
|
||
|
||
[C# Programming Guide]:http://msdn.microsoft.com/ru-ru/library/67ef8sbd.aspx
|
||
[R Language Definition]:http://cran.r-project.org/doc/manuals/R-lang.html
|
||
[T-SQL Reference]:https://docs.microsoft.com/en-us/sql/t-sql/language-reference
|
||
[PL/pgSQL Manual]:https://www.postgresql.org/docs/manuals/
|