Skip to content

Add links on best practice guidelines in coding guideline #4983

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
daxian-dbw merged 5 commits into from
Oct 5, 2017
Merged

Add links on best practice guidelines in coding guideline #4983

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
31882c6
Add links on best practice guidelines in coding guideline
iSazonov Oct 3, 2017
71a2c7f
Fix spelling
iSazonov Oct 3, 2017
b900581
Address feedback
iSazonov Oct 4, 2017
7365525
Remove unapproved additions
iSazonov Oct 5, 2017
e5e7a99
Remove 'System.NET' as it's been removed from doc
daxian-dbw Oct 5, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/dev-process/coding-guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,20 @@ See [CODEOWNERS](../../.github/CODEOWNERS) for more information about the area e
as it obscures the functional changes of the PR.
A separate PR should be submitted for such refactoring without any functional changes.

* Consider using the `Interlocked` class instead of the `lock` statement to atomically change simple states. The `Interlocked` class provides better performance for updates that must be atomic.

* Here are some useful links for your reference:
* [Framework Design Guidelines](https://docs.microsoft.com/en-us/dotnet/standard/design-guidelines/index) - Naming, Design and Usage guidelines including:
* [Arrays](https://docs.microsoft.com/en-us/dotnet/standard/design-guidelines/arrays)
* [Collections](https://docs.microsoft.com/en-us/dotnet/standard/design-guidelines/guidelines-for-collections)
* [Exceptions](https://docs.microsoft.com/en-us/dotnet/standard/design-guidelines/exceptions)
* [Best Practices for Developing World-Ready Applications](https://docs.microsoft.com/en-us/dotnet/standard/globalization-localization/best-practices-for-developing-world-ready-apps) - Unicode, Culture, Encoding and Localization.
* [Best Practices for Exceptions](https://docs.microsoft.com/en-us/dotnet/standard/exceptions/best-practices-for-exceptions)
* [Best Practices for Using Strings in .NET](https://docs.microsoft.com/en-us/dotnet/standard/base-types/best-practices-strings)
* [Best Practices for Regular Expressions in .NET](https://docs.microsoft.com/en-us/dotnet/standard/base-types/best-practices)
* [Serialization Guidelines](https://docs.microsoft.com/en-us/dotnet/standard/serialization/serialization-guidelines)
* [Managed Threading Best Practices](https://docs.microsoft.com/en-us/dotnet/standard/threading/managed-threading-best-practices)

## Portable Code

There are 3 primary preprocessor macros we use during builds:
Expand Down