dotnet core 编程规范
本文实际只是翻译 .NET Core foundational libraries 官方文档的编码风格
在 .NET Core foundational libraries项目使用的编程规范默认就是 VisualStudio 默认样式。
花括号
花括号使用 Allman style 风格,所有的花括号在新的一行开始。
关于 Allman style 就是如下,花括号放在下一行,而且花括号不进行缩进,花括号里面的代码缩进。
while (x == y)
{
something();
somethingelse();
}
但是对于单行的语句,可以不添加花括号,但是请把它放在同一行
if (xx == null) xx = new Foo();
单行语句同样建议添加花括号避免苹果的bug
如果不添加花括号,一定不要在嵌套时使用。
空格
使用 4 个空格作为一个缩进,而不是使用 tab
字段
所有的字段使用_camelCase
风格,而且尽可能使用readonly
。在 internal 和 private 访问的字段添加 _
前缀,对于静态的字段添加s_
前缀,对于线程静态的字段添加t_
前缀。如果使用了静态的字段而且可以设置readonly
,需要把readonly
放在static
后面。
最好不要公开字段,如果需要公开那么使用PascalCasing风格而且不添加前缀。
我不是很赞同对字段的风格,但是因为本文是翻译,我就没有添加自己的理解。
限定
不要添加 this.
,完全是没必要的。
我也不是很赞同这个,因为如果使用扩展方法,需要使用this.
访问
显示指定访问,即使访问是默认的,如private string _foo
,而不是string _foo
。访问需要放在最前面,如public abstract
,不建议abstract public
默认的访问是可能修改的
命名空间
对于引用需要放在文件的开头。
空行
禁止超过一行的空白,不可以使用两行空白。
不要使用两行分割两个类型。
多余空格
禁止在一行结束添加多余空格。通过 VisualStudio 的查看空格(ctrl+E,S)可以看到空格
参照现有
如果一个文件在格式规范定义之前已经有自己的规范,尽可能参照文件现有的规范而不是去修改他。
新的修改参照现有的文件的格式。
我一点都不赞同。
明显的类型
只能在明显可以知道对象类型可以使用 var ,如var stream = new FileStream(...)
。在无法明显知道对象类型不可以使用 var ,如var stream = OpenStandardInput()
。
关键字
使用语言的关键字代替 BCL 类型,如使用 int, string, float
代替Int32
,String
,Single
常量命名
对于所有的常量,包括静态只读,使用 PascalCasing
风格。如果需要使用 C++ 或其他代码对于命名有要求才可以使用其他的方法。
变量名字符串
如果使用变量名的常量,必须使用 nameof
关键字。
字段结构
字段必须放在一个类声明的最前面。
我一点都不赞成,因为谁会去管一个类的字段,我关心的是构造函数和公开属性、函数。
其他字符
如果在代码使用了 非 ascii 的字符,那么需要把他转换为 \uxx
方式,这样可以解决一些非 ascii 因为编译器分析的问题。
当然上面的要求只是对于编译的代码
Label
使用 Label 缩进一个小于当前缩进的标签
本作品采用知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议进行许可。欢迎转载、使用、重新发布,但务必保留文章署名林德熙(包含链接:http://blog.csdn.net/lindexi_gd ),不得用于商业目的,基于本文修改后的作品务必以相同的许可发布。如有任何疑问,请与我联系。
dotnet core 编程规范的更多相关文章
- DotNet Core 1.0 集成 CentOS 开发与运行环境部署
一. DotNet Core 1.0 开发环境部署 操作系统安装 我们使用CentOS 7.2.1511版本. 安装libunwind库 执行:sudo yum install libunwi ...
- flex+AS3编程规范
flex+AS3编程规范 Flex+AS3编码规范 http://www.cnblogs.com/jiahuafu/ 1. 缩写: 尽量避免使用缩写,使用缩写时尽量和Flex保持一致.但要记住一 ...
- 使用 dotnet core 和 Azure PaaS服务进行devOps开发(Web API 实例)
作者:陈希章 发表于 2017年12月19日 引子 这一篇文章将用一个完整的实例,给大家介绍如何基于dotnet core(微软.NET的最新版本,支持跨平台,跨设备的应用开发,详情请参考 https ...
- centos 配置.Net core 环境并部署dotnet Core文件
一.配置环境[Microsoft dotnet Core] 1) Add the dotnet product feed sudo rpm -Uvh https://packages.microsof ...
- .Net Core 编码规范
.Net Core 编码规范 标签: 未分类 概述 规范制定原则 方便代码的交流和维护. 不影响编码的效率,不与大众习惯冲突. 使代码更美观.阅读更方便. 使代码的逻辑更清晰.更易于理解. 术语定义 ...
- .Net基础——程序集与CIL HttpClient封装方法 .Net Core 编码规范 C#中invoke和beginInvoke的使用 WebServeice 动态代理类
.Net基础——程序集与CIL 1. 程序集和CIL: 程序集是由.NET语言的编译器接受源代码文件产生的输出文件,通常分为 exe和dll两类,其中exe包含Main入口方法可以双击执行,dll ...
- 2017-03-05 CentOS中配置守护服务(Supervisor)监听dotnet core web程序的运行
我们继续解决上篇博客的问题,我这个人有个毛病,不喜欢遗留什么问题,也不喜欢问题说不明白,具体要怎么解决一定要详尽,因为经常自己遇到问题的时候,去翻别人的博客,就会遇到这样的问题,很苦恼,又说废话了. ...
- devOps开发(Web API 实例)dotnet core 和 Azure PaaS服务
使用 dotnet core 和 Azure PaaS服务进行devOps开发(Web API 实例) 作者:陈希章 发表于 2017年12月19日 引子 这一篇文章将用一个完整的实例,给大家介绍如何 ...
- SonarQube系列二、分析dotnet core/C#代码
[前言] 本系列主要讲述sonarqube的安装部署以及如何集成jenkins自动化分析.netcore项目.目录如下: SonarQube系列一.Linux安装与部署 SonarQube系列二.分析 ...
随机推荐
- mui.init()和mui.plusReady()
1.每个用到mui的页面都调用下mui.init.2.如果需要使用大H5+对象,就写到plusReady中,如plus对象. HTML5+扩展api是针对手机APP的,只有才手机应用(比如手机浏览器) ...
- springBoot基础2
主要记录上一篇 springBoot基础 中涉及到的pom.项目结构.注解等 首先是pom: 关于pom中这段插件配置: <plugin> <groupId>org.sprin ...
- Windows平台下载Android源码(整理)
Google官方下载源码使用的系统Ubuntu系统,不过现在我们需要在Windows系统中下载Android源码文件. 网站的地址是:https://android.googlesource.com/ ...
- 国网电表dlt645-2007抄表软件
这个支持公网抄表 在以前局域网的基础上做了修正 使用起来更加便利了
- redis知识点杂记
最近梳理了一下redis的基本知识.本文会从redis的简单使用.redis的数据类型.redis持久化三个方面做简单阐述和总结. 一.Redis基本操作 1.key的规则 不能使用\n空格.其他都可 ...
- 背水一战 Windows 10 (92) - 文件系统: 读写“最近访问列表”和“未来访问列表”, 管理以及使用索引
[源码下载] 背水一战 Windows 10 (92) - 文件系统: 读写“最近访问列表”和“未来访问列表”, 管理以及使用索引 作者:webabcd 介绍背水一战 Windows 10 之 文件系 ...
- MyBatis 源码分析 - 配置文件解析过程
* 本文速览 由于本篇文章篇幅比较大,所以这里拿出一节对本文进行快速概括.本篇文章对 MyBatis 配置文件中常用配置的解析过程进行了较为详细的介绍和分析,包括但不限于settings,typeAl ...
- 8:String类
String类 String类的特点: 字符串对象一旦被初始化就不会被改变. 字符串是最常用的类型之一,所以为了使用方便java就给封装成了对象方便使用 public static void str ...
- Java中List, Integer[], int[]的相互转换
import java.util.Arrays; import java.util.List; import java.util.stream.Collectors; public class Mai ...
- 第二十七节:Java基础面向对象-静态,单例模式,继承详情知识点
前言 Java基础面向对象-静态,单例模式,继承详情知识点.静态-static关键字,static变量,静态代码块,代码块(不加静态),对象创建过程,单例模式,继承. 静态-static关键字 // ...