pete_westg wrote: > > στις 27/05/2010 13:02, O/H Viktor Szakáts έγραψε: > By "documentation friendly code" i mean two simple and very well known > things. > a. Short introductory description on top of source code (in place of > this long and more or less useless copyright reminding replica ) > b. in-line comments. > c. sample program. > [OK, they are three, but any combination of two will perfectly do the > job ;)] >
I think it should be MANDATORY to post comments in the sources of all PUBLIC functions, especially type HB_FUNC() and APIs, with a description of parameters and return. If You do fix a function that causes a change in parameters or return that You MUST be correcting a comment for this function. Adam -- View this message in context: http://harbour-devel.1590103.n2.nabble.com/Documentation-storm-on-user-s-list-tp5107834p5124785.html Sent from the harbour-devel mailing list archive at Nabble.com. _______________________________________________ Harbour mailing list (attachment size limit: 40KB) Harbour@harbour-project.org http://lists.harbour-project.org/mailman/listinfo/harbour
