कमेंट में

कमेंट के बारे में

कमेंट की मदद से आप कोड में नोट छोड़ सकते हैं, और इससे कोड के चलने पर कोई असर नहीं पड़ता। सिंगल-लाइन कमेंट किसी भी लाइन पर // से शुरू होता है। कंपाइलर उस लाइन में // से लेकर लाइन के अंत तक की हर चीज़ को अनदेखा कर देता है। जब एक ही लाइन में कोड के बाद कमेंट आता है, तो उसे अक्सर इनलाइन कमेंट कहा जाता है। मल्टीलाइन कमेंट किसी भी लाइन पर /* से शुरू होता है और */ पर खत्म होता है। कंपाइलर बीच की हर चीज़ को अनदेखा कर देता है, चाहे वह एक लाइन में हो या कई लाइनों में फैली हो।

// This is a single-line comment on its own line

x := 1 // This is an single-line comment inline with code
fmt.Println(x) // prints 1

/*
This is a valid
multiline comment.
*/

/* This is also a valid multi-line comment. */

कमेंट का उद्देश्य इस पर निर्भर करता है कि वह कहाँ लिखा गया है।

कोड कमेंट

कोड कमेंट यह बताते हैं कि कोई काम क्यों किया गया है, यह नहीं कि क्या किया गया है। जब किसी फैसले का कारण कोड देखकर साफ न समझ आए, तब इनका उपयोग कीजिए:

results = results[1:] // skipping the header row

ज़्यादातर मामलों में साफ-सुथरे ढंग से लिखा कोड खुद अपनी बात बता देता है और कमेंट की ज़रूरत नहीं पड़ती। कभी-कभी कोड को कोई जटिल या अप्रत्याशित काम करना पड़ता है; ऐसे कोड पर कमेंट लिखना चाहिए।

डॉक कमेंट

डॉक कमेंट किसी पैकेज, वेरिएबल या फंक्शन का डॉक्युमेंटेशन लिखने के लिए इस्तेमाल होते हैं। यह डॉक्युमेंटेशन उन दूसरे कोडर के लिए है जो जानना चाहते हैं कि आपके कोड का उपयोग कैसे किया जाए। इसमें ऊपरी स्तर पर यह समझाया जाना चाहिए कि कोड क्या करता है और उसका उपयोग कैसे किया जाए। इसमें यह ब्यौरा नहीं होना चाहिए कि कोड खुद अंदर से कैसे काम करता है। डॉक कमेंट किसी घोषणा के ठीक पहले लिखा जाता है, और कमेंट तथा घोषणा के बीच कोई खाली लाइन नहीं होती। godoc इन्हें पढ़कर पैकेज का डॉक्युमेंटेशन बनाता है, जैसा pkg.go.dev पर दिखता है। डॉक कमेंट एक पूरा वाक्य होना चाहिए, जो आइडेंटिफायर के नाम से शुरू हो और पूर्ण विराम पर खत्म हो।

एक्सपोर्ट किए गए आइडेंटिफायर (जो बड़े अक्षर से शुरू होते हैं) पर लिखे डॉक कमेंट बने हुए डॉक्युमेंटेशन में दिखते हैं। बिना एक्सपोर्ट किए आइडेंटिफायर (जो बड़े अक्षर से शुरू नहीं होते) पर लिखे डॉक कमेंट नहीं दिखते, लेकिन वे कोड के भीतर काम की जानकारी ज़रूर दे सकते हैं।

पैकेज का डॉक्युमेंटेशन लिखने वाले कमेंट पैकेज के नाम से शुरू होते हैं और बताते हैं कि वह पैकेज क्या करता है:

// Package kelvin provides tools to convert temperatures to and from Kelvin.
package kelvin

फंक्शन का डॉक्युमेंटेशन लिखने वाले कमेंट फंक्शन के नाम से शुरू होते हैं और बताते हैं कि वह फंक्शन क्या करता है, साथ ही उसके आर्गुमेंट और रिटर्न वैल्यू भी:

// CelsiusFreezingTemp returns an integer value equal to the temperature at which water freezes in degrees Celsius.
func CelsiusFreezingTemp() int {
    return 0
}

वेरिएबल का डॉक्युमेंटेशन लिखने वाले कमेंट वेरिएबल के नाम से शुरू होते हैं और बताते हैं कि वह वेरिएबल किस चीज़ को दर्शाता है:

// TemperatureFahrenheit represents a certain temperature in degrees Fahrenheit.
var TemperatureFahrenheit float64

डॉक कमेंट के पूरे नियम Go documentation guide में देखिए।