在我们正在实现的每个方法中使用#region是否合适

Question

最近,我的项目经理要求为我们迄今为止所做的所有工作撰写评论,摘要和#regions.甚至他也要求为变量声明写作.就像我们宣布金额是双倍一样,他要求我们这样写

  /// <summary>
    /// RegularPay declared as double
    /// </summary>
    private double m_dRegularPay;

甚至对于Get Set也是如此

  /// <summary>
    /// Get and Set FirstName
    /// </summary>
    public string FirstName
    {
        get
        {
            return m_sFirstName;
        }
        set
        {
            m_sFirstName = value;
        }
    }

和区域同时实现一些代码

   #region EmpHourly
    /// <summary>
    /// Get Employe Hourly Amount
    /// </summary>
    /// <param name="EmpAmount"></param>
    /// <param name="EmpRegularHours"></param>
    /// <param name="EmpHourlyRate"></param>
    /// <param name="EmpBonusPay"></param>
    /// <param name="EmpOtherHours"></param>
    /// <param name="EmpOverTimeHours"></param>
    /// <returns></returns>
    public bool GetEmpHourlyAmount(out double EmpAmount, out double EmpRegularHours, out double EmpHourlyRate, out double EmpBonusPay, out int EmpOtherHours, out int EmpOverTimeHours)
    {
     }

我想知道的是它是更好的编码标准方式

Answer 1

评论类字段和属性是一种很好的做法,但这里的区域似乎毫无意义.我还要补充一点,过度使用out变量并不是很好的C#风格.返回一个物体会更好.

Answer 2

地区很可怕.他们只是隐藏您想要查看的代码.对我来说,就像试图读一本书一样,但是有人对每一段都进行了封面.这没有道理.

我也认为学校评论请求值得推迟.它增加零值,创建繁忙工作,并模糊真实的评论(代码本身).

/// <summary>
/// RegularPay declared as double
/// </summary>
private double m_dRegularPay;

这说了三次同样的事情.它在评论中说,RegularPay是一个双重,私人双重RegularPay是一个私人双重,而m_dRegular支付是私人双.

实际上,评论和符号表明在某个时间点 m_dRegularPay是双倍的.私有双标识符表明它仍然是私有双.

private double regularPay;

这只说了一次.

Answer 3

这个评论惯例似乎过于热心......但不一致.

double RegularPay使用注释"RegularPay声明为double" 来注释该行是愚蠢忙碌的工作.这是显而易见的,指出它是多余的,浪费时间.

在您所在的地区,GetEmpHourlyAmount的摘要可能很重要,但不会将其视为此类.该方法的名称与注释一样有用.

一般来说,如果您发表评论,评论应该告诉您名称显然没有告诉您的内容.评论应显示更多有用的信息.