ജാവ പ്രമാണങ്ങൾ(Java Documentation)

തിരുത്തുക

വ്യാഖ്യാനം നൽകുക

നല്ല പ്രോഗ്രമിന്റേയും പ്രൊഗ്രാമറുടേയും ലക്ഷണമാണ് ഉറവിടസംഹിത (source code) വ്യക്തമായി വ്യാഖ്യാനിക്കുക(comment) എന്നുള്ളത്. എന്നു വച്ചാൽ നമ്മൾ എഴുതുന്ന ഓരോ പ്രസ്താവനകളും(statements) അനുബന്ധ സംഹിതയും പരിവർത്തിതവസ്‌തുക്കളും (codes & variables) എന്താണെന്നും എന്തിനാണെന്നും വ്യക്തമായി എഴുതുക. ജാവ ഇതിൽ ഒരുപടി മുന്നിലാണ്. നമ്മൾ വ്യക്തമായ ചില മാനദണ്ഡങ്ങൾ പിന്തുടർന്നാൽ, ജാവഡോക്(javadoc) എന്ന ഉപകരണമുപയോഗിച്ച് നല്ല വിവരണമുള്ള HTML താളുകൾ നിർമ്മിച്ചെടുക്കാം.

ഇതിലേക്ക് കടക്കും മുമ്പ്, ജാവ പ്രോഗ്രാമിൽ വ്യാഖ്യാനം ഉൾപ്പെടുത്തന്നതെങ്ങനെയെന്ന് നോക്കാം. സി, സി++ എന്നിവയിൽ ഉപയോഗിക്കുന്ന വ്യാഖ്യാന ചിഹ്നം തന്നെയാണ് ജാവയിലും ഉപയോഗിക്കുന്നത്. അതായത് ഒറ്റ വരി വ്യാഖ്യാന ഓപ്പറേറ്ററായി '//' ചിഹ്നവും ഒന്നിലധികം വരികളെ വ്യാഖ്യാനിക്കണമെന്നുണ്ടെങ്കിൽ ബഹുവരി വ്യാഖ്യാന ഓപറേറ്ററായ /*....*/ ഉം ആണ് ഉപയോഗിക്കേണ്ടത്.

//This is an example of single line comment
/* This is an exmaple of
multiple line comment
*/

വ്യാഖ്യാനം ഉൾപ്പെടുത്തിക്കൊണ്ടുള്ള ഒരു ജാവ പ്രോഗ്രാം ചുവടെ കൊടുത്തിരിക്കുന്നു.

/* Program to display
some information on the screen
*/
class Comment
{

public static void main(String[] args)
{
// Following statements display the information
System.out.println("I Love Malayalam");
System.out.println("I Love Wikipedia");
System.out.println("I Contribute to Wikipedia");
}

}

മുകളിൽ കൊടുത്ത പ്രോഗ്രാം പ്രവർത്തിപ്പിക്കുമ്പോൾ വ്യാഖ്യാനമായി നല്കിയ വരികളൊന്നും തന്നെ പ്രവർത്തിക്കുകയില്ല. അവ പ്രോഗ്രാം വായിക്കുന്നവർക്ക് മനസ്സിലാക്കുവാനുള്ള നിർദ്ദേശങ്ങളായി നിലനില്ക്കുകയേ ഉള്ളൂ. പ്രോഗ്രാമിന്റെ പരിണിതഫലം ഇതാണ്.
D:\JAVAPROG\>javac Comment.java
D:\JJAVAPROG\java Comment

I Love Malayalam
I Love Wikipedia
I Contribute to Wikipedia


'System.out.printIn()ൽ നാം നൽകിയിട്ടുള്ള ഡേറ്റ എപ്പോഴും ഒരു പുതിയ വരിയിലായിരിക്കും ഡിസ്‌പ്ലേ ചെയ്യുക. അതേ സമയം System.out.print() എന്നാണ് നാം നൽകുന്നതെങ്കിൽ ഡേറ്റ പഴയ ലൈനിൽ തന്നെയായിരിക്കും ഡിസ്‌പ്ലേ ചെയ്യുക. നേരത്തേ കൊടുത്ത പ്രോഗ്രാമിൽ 'println' എന്നത് മാറ്റി print() ഉൾപ്പെടുത്തി നോക്കാം.

// Program showing the function of print()
/* Program to display
some information on the screen
*/
class Comment
{

public static void main(String[] args)
{
// Following statements display the information
System.out.print("I Love Malayalam");
System.out.print("I Love Wikipedia");
System.out.print("I Contribute to Wikipedia");
}

}

മുകളിൽ കൊടുത്ത പ്രോഗ്രാം കംപൈൽ ചെയ്ത് പ്രവർത്തിപ്പിച്ചാൽ പരിണിതഫലം താഴെ കാണുന്ന രീതിയിലായിരിക്കും.
D:\JAVAPROG\>javac Comment.java
D:\JAVAPROG\java Comment

I Love MalayalamI Love WikipediaI Contribute to Wikipedia

നേരത്തെ ലഭിച്ച ഔട്ട്പുട്ടും ഇപ്പോൾ ലഭിച്ചതും തമ്മിൽ താരതമ്യം ചെയ്താൽ print()ന്റേയും printn()ന്റേയും പ്രവർത്തനത്തിലുള്ള വ്യത്യാസം മനസ്സിലാകും.