Hi, > is in Harbour docs an ordered list of Harbour extensions/substitute Clipper > functions ? > I searched among the various document but I haven't found anything. Maybe I > haven't searched deeply... > Furthermore, in the doc files the documentation of each function is not > described in depth: many times it's not enough to learn its use and also some > code snippet is missing. To find informations in changelog can be a solution > but, like in these days, functions and functionality change very quickly and > it's hard to find useful informations this way. I know that it's not easy to > write a proper documentation and it's precious time that a developer can't > spend, but who can document the use of a function/class/project, if not the > developer itself?
Shoving every task to the developers doesn't scale very well, they have finite time like everyone else. Moreover developers are in many cases not the best or ideal documentation writers. The two tasks require quite a different skill set. > Sometimes in the past I used C# (for very very very little time) and by using > a triple slash /// I could document each code that I was writing. The C# IDE > parsed each file in search of those tags and when we needed help over a > particular function, It showed us the informations that we put after those > tags. > Perhaps, we could use the same construct to help us to make a better > auto-documentation. It may be used in any part of Harobur code, .c, .prg and > other files (not only in the header) and it's not so far the // that a > Clipper programmer is used to use in its code. This has been discussed a lot on this list, and it's really not a technical problem, it simply needs contributors, willing to give something (in this case documentation writing) back to the project they're getting for free. Brgds, Viktor _______________________________________________ Harbour mailing list (attachment size limit: 40KB) Harbour@harbour-project.org http://lists.harbour-project.org/mailman/listinfo/harbour
