Sunday, May 01, 2005

Comment to easy Read sourcecode

Comment Important?

Now, You can read sourcecode ? it's Hard ? Not understand ? but sourcecode in the world is not understand because use for write's programmer .
I want propose to write comment to use write code for easy to read and edit by self and easy to other people to read .

Concept
1. set head comment to before write code

;--------------------------------------------------
;
; method name : hello world
; Description : for test method
;
;--------------------------------------------------


2. description detail method

public static void main()
{
system.out.println("Hello world"); // show message to monitor
}



special
you can make comment in the head file for formal code
example :

; ----------------------------
; Source code for show program is Hello
; write by Itsara Konsombut
; at 7.55 pm 1/5/2005
;in computer club at Suranaree University of technology
;-----------------------------

final :
this is form simple to use write code by me