C# Language
टिप्पणियाँ और क्षेत्र

टिप्पणियाँ

अपनी परियोजनाओं में टिप्पणियों का उपयोग करना आपके डिजाइन विकल्पों के स्पष्टीकरण को छोड़ने का एक आसान तरीका है, और कोड को बनाए या जोड़ते समय अपने (या किसी और के) जीवन को आसान बनाने का लक्ष्य रखना चाहिए।

आपके कोड में एक टिप्पणी जोड़ने के दो तरीके हैं।

एकल पंक्ति टिप्पणियाँ

// बाद रखा गया कोई भी पाठ टिप्पणी के रूप में माना जाएगा।

public class Program
{
    // This is the entry point of my program.
    public static void Main()
    {
        // Prints a message to the console. - This is a comment!
        System.Console.WriteLine("Hello, World!"); 

        // System.Console.WriteLine("Hello, World again!"); // You can even comment out code.
        System.Console.ReadLine();
    }
}

मल्टी लाइन या सीमांकित टिप्पणियाँ

/* और */ बीच किसी भी पाठ को एक टिप्पणी के रूप में माना जाएगा।

public class Program
{
    public static void Main()
    {
        /*
            This is a multi line comment
            it will be ignored by the compiler.
        */
        System.Console.WriteLine("Hello, World!");

        // It's also possible to make an inline comment with /* */
        // although it's rarely used in practice
        System.Console.WriteLine(/* Inline comment */ "Hello, World!");
  
        System.Console.ReadLine();
    }
}

क्षेत्र

एक क्षेत्र कोड का एक बंधनेवाला ब्लॉक है, जो आपके कोड की पठनीयता और संगठन के साथ मदद कर सकता है।

नोट: StyleCop का नियम SA1124 DoNotUseRegions क्षेत्रों के उपयोग को हतोत्साहित करता है। वे आमतौर पर बुरी तरह से संगठित कोड का संकेत हैं, क्योंकि C # में आंशिक कक्षाएं और अन्य विशेषताएं शामिल हैं जो क्षेत्रों को अप्रचलित बनाती हैं।

आप निम्नलिखित तरीके से क्षेत्रों का उपयोग कर सकते हैं:

class Program
{
    #region Application entry point
    static void Main(string[] args)
    {
        PrintHelloWorld();
        System.Console.ReadLine();
    }
    #endregion

    #region My method
    private static void PrintHelloWorld()
    {
        System.Console.WriteLine("Hello, World!");
    }
    #endregion
}

जब एक IDE में उपरोक्त कोड दिखाई देता है, तो आप + और - प्रतीकों का उपयोग करके कोड को ढहाने और विस्तारित करने में सक्षम होंगे।

विस्तारित

संक्षिप्त किए गए

प्रलेखन टिप्पणियाँ

XML दस्तावेज़ीकरण टिप्पणियों का उपयोग एपीआई प्रलेखन प्रदान करने के लिए किया जा सकता है जिसे आसानी से उपकरण द्वारा संसाधित किया जा सकता है:

/// <summary>
/// A helper class for validating method arguments.
/// </summary>
public static class Precondition
{
    /// <summary>
    ///     Throws an <see cref="ArgumentOutOfRangeException"/> with the parameter
    ///     name set to <c>paramName</c> if <c>value</c> does not satisfy the 
    ///     <c>predicate</c> specified.
    /// </summary>
    /// <typeparam name="T">
    ///     The type of the argument checked
    /// </typeparam>
    /// <param name="value">
    ///     The argument to be checked
    /// </param>
    /// <param name="predicate">
    ///     The predicate the value is required to satisfy
    /// </param>
    /// <param name="paramName">
    ///     The parameter name to be passed to the
    ///     <see cref="ArgumentOutOfRangeException"/>.
    /// </param>
    /// <returns>The value specified</returns>
    public static T Satisfies<T>(T value, Func<T, bool> predicate, string paramName)
    {
        if (!predicate(value))
            throw new ArgumentOutOfRangeException(paramName);

        return value;
    }
}

इंटेलीजेंसी द्वारा प्रलेखन को तुरंत उठाया जाता है: