टिप्पणियों की आवश्यकता कोड के अमूर्त स्तर के व्युत्क्रमानुपाती होती है।
उदाहरण के लिए, असेंबली लैंग्वेज सबसे व्यावहारिक उद्देश्यों के लिए है, टिप्पणियों के बिना अनजाने। यहाँ एक छोटे से कार्यक्रम का अंश दिया गया है जो फाइबोनैचि श्रृंखला की शर्तों की गणना करता है और छापता है :
main:
; initializes the two numbers and the counter. Note that this assumes
; that the counter and num1 and num2 areas are contiguous!
;
mov ax,'00' ; initialize to all ASCII zeroes
mov di,counter ; including the counter
mov cx,digits+cntDigits/2 ; two bytes at a time
cld ; initialize from low to high memory
rep stosw ; write the data
inc ax ; make sure ASCII zero is in al
mov [num1 + digits - 1],al ; last digit is one
mov [num2 + digits - 1],al ;
mov [counter + cntDigits - 1],al
jmp .bottom ; done with initialization, so begin
.top
; add num1 to num2
mov di,num1+digits-1
mov si,num2+digits-1
mov cx,digits ;
call AddNumbers ; num2 += num1
mov bp,num2 ;
call PrintLine ;
dec dword [term] ; decrement loop counter
jz .done ;
; add num2 to num1
mov di,num2+digits-1
mov si,num1+digits-1
mov cx,digits ;
call AddNumbers ; num1 += num2
.bottom
mov bp,num1 ;
call PrintLine ;
dec dword [term] ; decrement loop counter
jnz .top ;
.done
call CRLF ; finish off with CRLF
mov ax,4c00h ; terminate
int 21h ;
टिप्पणियों के साथ भी, यह काफी जटिल हो सकता है।
आधुनिक उदाहरण: रेग्जेस अक्सर बहुत कम अमूर्त निर्माण होते हैं (निचले मामले पत्र, संख्या 0, 1, 2, नई लाइनें, आदि)। उन्हें शायद नमूनों के रूप में टिप्पणियों की आवश्यकता है (बॉब मार्टिन, IIRC, यह स्वीकार करता है)। यहाँ एक regex है जो मुझे लगता है कि HTTP (S) और FTP URL से मेल खाना चाहिए:
^(((ht|f)tp(s?))\://)?(www.|[a-zA-Z].)[a-zA-Z0-9\-\.]+\.(com|edu|gov|m
+il|net|org|biz|info|name|museum|us|ca|uk)(\:[0-9]+)*(/($|[a-zA-Z0-9\.
+\,\;\?\'\\\+&%\$#\=~_\-]+))*$
जैसे-जैसे भाषाएं अमूर्त पदानुक्रम को आगे बढ़ाती हैं, प्रोग्रामर अंतर्निहित प्रलेखन प्रदान करने के लिए एवोकैटिक एब्स्ट्रक्शन (चर नाम, फ़ंक्शन नाम, वर्ग नाम, मॉड्यूल नाम, इंटरफेस, कॉलबैक आदि) का उपयोग करने में सक्षम होता है। इसका लाभ उठाने के लिए उपेक्षा करने के लिए, और उस पर कागज के लिए टिप्पणियों का उपयोग करना आलसी है, अनुरक्षक के प्रति असंतोष और अपमानजनक है।
मैं सोच रहा हूँ सी में न्यूमेरिकल व्यंजनों ज्यादातर को शब्दशः अनुवाद सी ++ में न्यूमेरिकल व्यंजनों , जो मैं अनुमान कर के रूप में शुरू न्यूमेरिकल व्यंजनों (FORTAN में), सभी चर के साथ a, aa, b, c, cc, आदि प्रत्येक संस्करण के माध्यम से बनाए रखा। एल्गोरिदम सही हो सकता है, लेकिन उन्होंने प्रदान की गई भाषाओं के सार का लाभ नहीं उठाया। और उन्होंने पी *** मुझे बंद कर दिया। डॉ। डॉब्स लेख से नमूना - फास्ट फूरियर ट्रांसफॉर्म :
void four1(double* data, unsigned long nn)
{
unsigned long n, mmax, m, j, istep, i;
double wtemp, wr, wpr, wpi, wi, theta;
double tempr, tempi;
// reverse-binary reindexing
n = nn<<1;
j=1;
for (i=1; i<n; i+=2) {
if (j>i) {
swap(data[j-1], data[i-1]);
swap(data[j], data[i]);
}
m = nn;
while (m>=2 && j>m) {
j -= m;
m >>= 1;
}
j += m;
};
// here begins the Danielson-Lanczos section
mmax=2;
while (n>mmax) {
istep = mmax<<1;
theta = -(2*M_PI/mmax);
wtemp = sin(0.5*theta);
wpr = -2.0*wtemp*wtemp;
wpi = sin(theta);
wr = 1.0;
wi = 0.0;
for (m=1; m < mmax; m += 2) {
for (i=m; i <= n; i += istep) {
j=i+mmax;
tempr = wr*data[j-1] - wi*data[j];
tempi = wr * data[j] + wi*data[j-1];
data[j-1] = data[i-1] - tempr;
data[j] = data[i] - tempi;
data[i-1] += tempr;
data[i] += tempi;
}
wtemp=wr;
wr += wr*wpr - wi*wpi;
wi += wi*wpr + wtemp*wpi;
}
mmax=istep;
}
}
अमूर्तता के बारे में एक विशेष मामले के रूप में, हर भाषा में कुछ सामान्य कार्यों के लिए मुहावरे / विहित कोड स्निपेट होते हैं (C में डायनामिक लिंक्ड लिस्ट डिलीट करना), और इस बात की परवाह किए बिना कि वे कैसे प्रलेखित नहीं होने चाहिए। प्रोग्रामर को इन मुहावरों को सीखना चाहिए, क्योंकि वे अनौपचारिक रूप से भाषा का हिस्सा हैं।
तो दूर ले जाओ: गैर-मुहावरेदार कोड निम्न-स्तर के बिल्डिंग ब्लॉक्स से बनाया गया है जिसे टाला नहीं जा सकता टिप्पणी की जरूरत है। और यह आवश्यक है कि यह कम से कम WAAAAY होता है।