TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Code comments extraction for documentation From:"John Harrington" <beartiger -at- gmail -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Mon, 23 Oct 2006 11:18:19 -0700
By "comments extraction", I mean extracting comments from code (e.g.,
c++) for use in documentation (e.g., of a software developers' kit).
If there is a more standard name for this, please let me know.
Has anyone on the list tackled the problem of comments extraction in a
documentation project?
1) What tool(s) did you use/recommend? Or did you roll your own?
2) What are some other leading tools you know about and why did you
prefer the solution you used?
3) How did you deal with editorial review and updates to content?
I'd be grateful for any comments anyone is willing to offer.
Many thanks,
John Harrington
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l
Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList