CodeSOD: Templated Comments

Вторник, 23 Ноября 2021 г. 09:30 + в цитатник

Mike's company likes to make sure their code is well documented. Every important field, enumeration, method, or class has a comment explaining what it is. You can see how much easier it makes understanding this code:

    /// 
    /// Provides clear values for Templates
    /// 
    public enum TemplateType
    {
        /// 
        /// 1
        /// 
        TEMPLATE_1 = 1,
        /// 
        /// 2
        /// 
        TEMPLATE_2 = 2,
        /// 
        /// 3
        /// 
        TEMPLATE_3 = 3,
        /// 
        /// 6
        /// 
        TEMPLATE_6 = 6,
        /// 
        /// 8
        /// 
        TEMPLATE_8 = 8,
        /// 
        /// 10
        /// 
        TEMPLATE_10 = 10,
        /// 
        /// 12
        /// 
        TEMPLATE_12 = 12,
        /// 
        /// 17
        ///        
        TEMPLATE_17 = 17,
        /// 
        /// 18
        /// 
        TEMPLATE_18 = 18,
        /// 
        /// 20
        /// 
        TEMPLATE_20 = 20,
        /// 
        /// 32
        /// 
        TEMPLATE_32 = 32,
        /// 
        /// 42
        /// 
        TEMPLATE_42 = 42,
        /// 
        /// 54
        /// 
        TEMPLATE_54 = 54,
        /// 
        /// 55
        /// 
        TEMPLATE_55 = 55,
        /// 
        /// 57
        /// 
        TEMPLATE_57 = 57,
        /// 
        /// 73
        /// 
        TEMPLATE_73 = 73,
        /// 
        /// 74
        /// 
        TEMPLATE_74 = 74,
        /// 
        /// 177
        /// 
        TEMPLATE_177 = 177,
        /// 
        /// 189
        /// 
        TEMPLATE_189 = 189
    }