Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 2.56 KB

codingConventions.md

File metadata and controls

51 lines (33 loc) · 2.56 KB
Raw

Cording Conventions

This project follows Microsoft's Framework Design Guidelines or C# Coding Conventions. I also define the code style used in this project in NuGetImporterForUnity/.editorconfig. If you clean up your code with this setting, you are fine as for the code style. (Please let me know if there's any part of the code style I'm not following.)

Naming Guidelines

The camel casing convention, used only for parameter names, capitalizes the first character of each word except the first word. The PascalCasing convention, used for all identifiers except parameter names, capitalizes the first character of each word (including acronyms over two letters in length). Choose easily readable identifier names, and DO NOT use abbreviations or contractions as part of identifier names. For more infomation, see Naming Guidelines - Microsoft.

Layout Conventions

  • Use the default Code Editor settings (smart indenting, four-character indents, tabs saved as spaces).
  • Write only one statement per line.
  • Write only one declaration per line.
  • If continuation lines are not indented automatically, indent them one tab stop (four spaces).
  • Add at least one blank line between method definitions and property definitions.

Commenting Conventions

  • Place the comment on a separate line, not at the end of a line of code.
  • Begin comment text with an uppercase letter.
  • End comment text with a period (except for a single noun).

Implicitly Typed Variables

  • Use implicit typing for local variables when the variable type is obvious from the right side of the assignment or when the precise type is unimportant.
  • Do not use var when the type is not apparent from the right side of the assignment.
  • Use implicit typing to determine the type of the loop variable in for loops.
  • Do not use implicit typing to determine the type of the loop variable in foreach loops.

using directive

We must write the using directives outside of the namespace (basically at the top of the file). The order of using directives is as follows, and we should separate each group by one line.

  1. System
  2. other

For example

using System;
using System.Collections.Generic;
using System.Linq;

using kumaS.NuGetImporter.Editor.DataClasses;

using UnityEditor;

using UnityEngine;