专栏首页me的随笔Visual Studio 代码风格约束

Visual Studio 代码风格约束

团队内部若能统一代码风格对于日后的项目维护大有裨益,但面对厚达十几甚至几十页的代码风格规范,开发人员难免产生抵触心理。Python和Go等在语言层面就对代码风格作了一定的约束,但C#并没有,为解决这个问题,我们可以在VS中设置团队内部要统一采用的代码风格。

文中所用VS版本信息如下:

设置代码风格

在VS搜索框中搜索Code Style

我们可以自定义代码风格以及对不符合风格代码做怎样的处理,这里是按照错误进行处理

可以看到对于不符合规范的命名VS会报错并给出改建建议:

注意,这里的错误是IDE1006:Naming rule violation,编译时依然能通过(没找到在哪里设置不允许通过编译):


下面是代码风格示例代码,仅供参考:

class Person
{
    private const string FIRST_NAME = "firstName";

    private static string StaticField = "static field";

    private readonly string ReadOnlyField = "readOnlyField";

    private string _privateField;

    public Person(string privateField)
    {
        _privateField = privateField;
    }

    public void Method(int parameters)
    {
        try
        {
            var local = "";
            WriteLine(parameters);
        }
        catch (Exception)
        {
        }
        finally
        {
        }
    }
}

delegate void DelegateType(int i);

struct ValueType
{
    public event DelegateType DelegateTypeEvent;

    public void DelegateType()
    {
        if (DelegateTypeEvent != null)
        {
            for (var i = 0; i < 10; i++)
            {
                DelegateTypeEvent(i);
            }
        }
        else
        {
            throw new NullReferenceException();
        }
    }
}

interface IPerson
{
    void Say(string parameters);
}

enum WeekDays
{
    Monday,
    Tuesday
}

工具推荐

阿里团队的适用于JAVA代码风格检测插件P3C安装到IDEA中后,会对代码风格进行检测并给出改进建议

小结

统一的代码风格很重要,在编码时我们要求代码结构灵活易扩展,但对于代码风格应当讲究“死板”,不可灵活多变。

若团队内部的任一成员拿到项目代码一眼望去感觉像自己写的,那么我们就可以认为团队内的代码风格已经统一了。目前,我还不赞成过于苛求细节的代码风格约束(这种想法将来可能会变)。

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 【译】《Clean C#》

    本文是《Clean C#》一书译文的序言,阅读译文请移步至:《Clean C#》译文。

    雪飞鸿
  • 【译】《Clean C#》

    本文是《Clean C#》一书译文的序言,阅读译文请移步至:《Clean C#》译文。

    雪飞鸿
  • jQuery.ajax 根据不同的Content-Type做出不同的响应

    使用H5+ASP.NET General Handler开发项目,使用ajax进行前后端的通讯。有一个场景需求是根据服务器返回的不同数据类型,前端进行不同的响应...

    雪飞鸿
  • 【重磅干货】Matlab 高频算法交易——从基础到高级算法的完美实现(源码附送,这货太干了!)

    由于内容较多,附上部分代码和截图。具体内容,大家下载后进行学习。 ? ? ? ? ? ? ? ? ? ? ? ?

    量化投资与机器学习微信公众号
  • Python程序员鲜为人知但你应该知道的16个问题

    这篇文章主要介绍了Python程序员代码编写时应该避免的16个“坑”,也可以说成Python程序员代码编写时应该避免的16个问题,需要的朋友可以参考。 1. ...

    CDA数据分析师
  • 你在github上泄漏的密码改了吗

    大家作为安全爱好者或者从业者,大部分也是一个程序员,既然是程序员就离不开写代码,写代码就离不开 github,用 github 就喜欢在上面公开分享一些自己写的...

    信安之路
  • 开眼 | 盘点那些改变世界的代码

    2009 年,Facebook 推出了一份改变世界的代码——点「赞」按钮。「赞」是包括 Leah Pearlman 和 Justin Rosenstein 在内...

    昱良
  • 为什么有些程序员不愿意缩进代码?

    作为已经写了十几年代码的老程序员,虽然在编写代码的时候大部分情况还是遵循编码规范,但在这基础上会展示自己一些特性,有些程序员不喜欢缩进代码也是源于此,如同一个人...

    程序员互动联盟
  • 怎样编写高质量的Java代码

    代码质量概述 怎样辨别一个项目代码写得好还是坏?优秀的代码和腐化的代码区别在哪里?怎么让自己写的代码既漂亮又有生命力?接下来将对代码质量的问题进行一些粗略的介绍...

    用户1257393
  • 怎样编写高质量的Java代码

    怎样辨别一个项目代码写得好还是坏?优秀的代码和腐化的代码区别在哪里?怎么让自己写的代码既漂亮又有生命力?接下来将对代码质量的问题进行一些粗略的介绍。也请有过代码...

    哲洛不闹

扫码关注云+社区

领取腾讯云代金券