बस एक टिप्पणी
Defensive R Programming
Colin Gillespie
Jumping Rivers
मुझे नहीं पता आपके बारे में...
- जो कोड आज स्पष्ट है
- कुछ हफ्तों में अक्सर उतना स्पष्ट नहीं रहता
Comments
- आप R कोड में
#से comments जोड़ सकते हैं - अच्छे comments लिखना कठिन होता है!
# This is a comment
# The above comment isn't very helpful
# Or is it?
टिप 1: ज़ाहिर टिप्पणियों से बचें
- क्या स्पष्ट है, यह तय करना कभी-कभी कठिन होता है
- जैसे ये comments
ठीक लगते हैं# Loop through data sets for (dataset in datasets) { # Read in data set r <- read.csv(dataset) } - लेकिन शायद बहुत ज़्यादा स्पष्ट हैं
- जैसे ये comments
टिप 2: वे comments न लिखें जिन्हें आप कभी अपडेट नहीं करेंगे
सबसे आम उदाहरण फ़ाइल के ऊपर header comments होते हैं
# Last updated: 1967-02-25
# Author: D Law
# Status: No 1
- ऐसे comments लगभग कभी अपडेट नहीं होते
- मैंने एक बार देखा था
# list of packages used: XXX, YYY
टिप 3: एकरूप रहें
- हमेशा एक
#या दोहरे##से शुरू करें - बड़े अक्षर से शुरू करें - व्याकरण के नियम मानें
- चुटकुलों में सावधानी रखें
- जो आपको मज़ेदार लगे, दूसरों को बुरा लग सकता है
- उस कोड पर ज़रूर comment करें जो "ग़लत दिखता" हो
- भविष्य की समस्या दर्शाने को # TODO या # XXX इस्तेमाल करें
अभ्यास करते हैं!
Defensive R Programming
