C#代码风格指南
参考资料: asp.net 主页仓库
代码风格 —— 一般原则
最通用的指导原则是我们使用所有的VS默认设置的代码格式,除了我们把系统命名空间放在其他命名空间之前(这在VS中是默认的,但是在VS的更新版本中已经改变了)。
- 使用四个空格缩进(不用Tab)
- 私有字段使用
_camelCase
- 除非必要,避免使用
this.
- 始终指定成员的可见性,即使你将使用的可见性和默认可见性一致
- 开放的大括号(
{
)要另起一行 - 你可以使用任何可用的语言特性,但是你要保持代码易读、易于维护
- 举一个反例:
public (int, string) GetData(string filter) => (Data.Status, Data.GetWithFilter(filter ?? throw new ArgumentNullException(nameof(filter))));
- 这是一条很难读懂的语句
- 举一个反例:
使用var声明变量
只要编译器允许,那么尽可能的使用var声明变量,比如下面的代码:
var fruit = "Lychee"; var fruits = new List<Fruit>(); var flavor = fruit.GetFlavor(); string fruit = null; // can't use "var" because the type isn't known (though you could do (string)null, don't!) const string expectedName = "name"; // can't use "var" with const
反面例子:
string fruit = "Lychee"; List<Fruit> fruits = new List<Fruit>(); FruitFlavor flavor = fruit.GetFlavor();
在公共API中只使用完整的单词或通用/标准缩写
公共名称空间,类型名称,成员名称和参数名称必须使用完整的单词或通用/标准缩写。
示例:
public void AddReference(AssemblyReference reference); public EcmaScriptObject SomeObject { get; }
反例:
public void AddRef(AssemblyReference ref); public EcmaScriptObject SomeObj { get; }
使用C#类型关键字,而不是.Net Type名
例如:
public string TrimString(string s) { return string.IsNullOrEmpty(s) ? null : s.Trim(); } var intTypeName = nameof(Int32); // can't use C# type keywords with nameof
反例:
public String TrimString(String s) { return String.IsNullOrEmpty(s) ? null : s.Trim(); }
异步方法模式
默认情况下,所有异步方法都必须具有Async
后缀
扩展方法模式
一般的规则是:如果一个普通的静态方法就足够了,避免使用扩展方法。
扩展方法通常对创建可链式调用的方法非常有用,例如,在构建复杂对象或创建查询时。
内部扩展方法是允许的,但要记住先前的指导方针:拍拍胸脯问问自己,扩展方法是否真的是最合适的模式。
扩展方法类的名称空间通常应该是表示扩展方法功能的名称空间,而不是目标类型的名称空间,一个常见的例外是中间件扩展方法的命名空间通常总是与IAppBuilder
的命名空间相同。
扩展方法容器(也称为“sponsor type”)的类名通常应遵循<Feature>Extensions
,<Target><Feature>Extensions
或<Feature> <Target>Extensions
的模式。例如:
namespace Food { class Fruit { ... } } namespace Fruit.Eating { class FruitExtensions { public static void Eat(this Fruit fruit); } OR class FruitEatingExtensions { public static void Eat(this Fruit fruit); } OR class EatingFruitExtensions { public static void Eat(this Fruit fruit); } }
在编写接口的扩展方法时,sponsor type名称不能以I
开头。
Doc comments
编写代码的人将写入Doc comments,仅限公共API。非公开类型不需要Doc comments。
注:public意味着下游可以调用,所以它包含受保护的API。但是,一些公共API可能仍然是“仅供内部使用”,但由于技术原因需要公开。我们仍然会针对这些API提供文档,但是会根据情况进行记录。
常量定义
常量的定义使用帕斯卡命名法,避免使用全大写命名
例如:
public const string HashKey="ie832js834u9f9wq3h";
错误:
public const string HASH_KEY="ie832js834u9f9wq3h";
缩写算作单词,避免使用全字符大写
例如:
var api ="... public void FindApi(...
错误:
var API ="... public void FindAPI(...
例如常见的WTO是缩写,但是建议算作单词,写为 Wto、wto而不是WTO
低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。
持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。
转载内容版权归作者及来源网站所有,本站原创内容转载请注明来源。
- 上一篇
使用缓存时对于加锁的思考
突然发现之前写的自己实现XXX的话题不是很被大众关注,可能是真的写的不行,也可能是大多都是一些吃了饭没事做瞎写的一些东西,大家都没兴趣,之后可能会尽量写一些真正实用的东西,大家一起学习。言归正传,促使我研究这个话题的原因是在工作中遇到需要自己实现多级缓存的情况。比如在springboot中我们虽然可以随意替换缓存技术,可以使用redis也可以使用ehcache,但是据我所知,这些缓存默认都是只能使用一种。假设现在我需要同时使用ehcache和redis,其中ehcache做本地的第一级缓存。这里忽略可能用到的mybatis,hibernate那些操作数据库的orm框架的缓存,单独只考虑应用层面的缓存。当然在已经有springboot,ehcache,redis的情况下,通过自定义注解,切面拦截,组合ehcache和redis的两级缓存,其实并不是很困难。难点只在于细节部分,比如怎么让自己定义的注解和切面可以被springboot中的缓存注解开关@EnableCaching控制,又比如多点部署时怎么让ehcache本地缓存和redis集中式缓存实现同步,当然也有使用缓存的时候怎么加锁的问...
- 下一篇
巧用fastjson自定义序列化类实现字段的转换
项目中突然需要增加另一个字段的查找,而这个查找需要查另一张表的记录。 但现在产品很多地方都要增加该字段,如何最快的实现该功能呢。 办法如下: 通过fastjson序列化时,增加该字段的序列化类,该序列化类通过CODE查找名称,并序列化到前端。 VO的功能修改 @Data public class SysDictItemSelectVo implements Serializable{ private static final long serialVersionUID = 1L; @JSONField(serializeUsing=ToSystemNameSerializer.class) private String systemName; public String getSystemName(){ return this.getCode(); } } 序列化的类的属性 import com.alibaba.fastjson.serializer.JSONSerializer; import com.alibaba.fastjson.serializer.ObjectSeriali...
相关文章
文章评论
共有0条评论来说两句吧...
文章二维码
点击排行
推荐阅读
最新文章
- Linux系统CentOS6、CentOS7手动修改IP地址
- CentOS8编译安装MySQL8.0.19
- Docker使用Oracle官方镜像安装(12C,18C,19C)
- CentOS7,CentOS8安装Elasticsearch6.8.6
- SpringBoot2整合MyBatis,连接MySql数据库做增删改查操作
- CentOS关闭SELinux安全模块
- MySQL8.0.19开启GTID主从同步CentOS8
- 设置Eclipse缩进为4个空格,增强代码规范
- SpringBoot2整合Redis,开启缓存,提高访问速度
- Docker快速安装Oracle11G,搭建oracle11g学习环境