Intensive Program Documentation

Program documents are very important in understanding a program. But current program comment mechanism is awkward and unfriendly to read and writ, it cannot annotate a program clearly and completely. This paper proposes a different approach of program comments, programmers are no to longer to write comments randomly and arbitrarily. Our system will ask programmers to annotate a program according to the specification embedded in the grammar, programmers can use not only text, but video and sound to express the meaning of a program easily and completely. The quantity of comments will be put into a database, which can be queried by the project managers, customers, and software quality assurance specialists etc. to acquire a comprehensive software metrics of program comments. Besides the program and comments are represented as the HTML format, which can be browsed by most browsers via Internet.