The following are selected links to other web sites with useful
information about source code documentation and Help authoring.
| |
|
|
WinWriters
|
WritersUA - Training and Information for User Assistance Professionals.
|
|
Helpware
|
Helpware is an excellent resource for questions around HTML Help, Help 2 and
Windows Help as well as Help authoring in general. They have lots of
in-depth knowledge about Help compilers as well as up-to-date information
on newest developments in the industry.
|
|
XML Documentation
|
In Visual Studio .NET, 2003 and 2005 you can document the code you
write using XML (supported by Doc-O-Matic).
|
|
JavaDoc
|
Comprehensive information about Sun's JavaDoc standard (supported by Doc-O-Matic).
|
|
MSDN Article on XML Comments
|
This article shows how to use XML comments and explains the relevant
tags. The author demonstrates how to set up your project to export
your XML comments into convenient documentation for the benefit of
other developers.
|
|
Writing Understandable Code
|
Recommended reading on software documentation.
|
| |
|
