C# 代码规范（微软）

C# Coding Standards

Your Company Name Here

Abstract

This document contains coding conventions and style guidelines that will ensure that C# code will

be of consistent and superior quality. It includes general coding guidelines as well as discussions

on naming, formatting, and language usage patterns.

Contents

1. Introduction......................................................................................................................................................... 3

3.1 Class Layout 5

3.2 Indicating Scope 5

3.3 Indentation & Braces 6

3.4 White space 6

3.5 Long lines of code 7

4. Commenting........................................................................................................................................................ 8

4.1 Intellisense Comments 8

4.2 End-Of-Line Comments 8

4.3 Single Line Comments 8

4.4 // TODO: Comments 8

6.2 Classes & Structures 10

6.3 Interfaces 10

6.4 Constants 11

6.5 Enumerations 11

6.6 Variables, Fields & Parameters 11

6.7 Properties 12

6.8 Methods 13

Your Company Name Here 1

6.9 Event Handlers 13

6.10 Error Handling 13

Your Company Name Here 2

1. Introduction

1.1 Purpose

The purpose of this document is to provide coding style standards for the development of source code written in C#.

Adhering to a coding style standard is an industry proven best-practice for making team development more efficient and

application maintenance more cost-effective. While not comprehensive, these guidelines represent the minimum level of

standardization expected in the source code of projects written in C#.

1.2 Scope

This document provides guidance on the formatting, commenting, naming, and programming style of C# source code

and is applicable to component libraries. web services, web sites, and rich client applications.

1.3 Document Conventions

Example code is shown using the Code font and shows syntax as it would be color coded in Visual Studio’s code editor.

Your Company Name Here 3