Auto generated documentation

  • Thread starter Thread starter Sasa Tomicic
  • Start date Start date
S

Sasa Tomicic

Hello!

Currently C# supplies us with the support for auto generating of the comment
web pages (project documentation) through the IDE option "Tools/Build
Comment Web Pages...".

But what about Managed C++!? Would in future the documentation format be the
same as for the C# or should we expect some C++ specific keywords and
comment rules.

If we start to write our managed C++ code comments using C# comment keywords
(using <summary>, <remarks>...), would it work with the Whidbey C++?

Thanks, Sasa
 
Sasa Tomicic said:
If we start to write our managed C++ code comments using C# comment keywords
(using <summary>, <remarks>...), would it work with the Whidbey C++?
Click to expand...

Yes, it works. I had no docs for all this, but my personal impression is
that it is still very buggy.

I added the /doc switch to the C/C++ command line and executed "xdcmake
$(TargetDir)$(TargetName)" as a custom post-build event.

Things that didn't work for me include

- Large comment blocks (compilation errors in comments when using /doc)
- cref can only be resolved when the target has been previously declared:
- I don't know e.g. how to refer to members from the type doc
- You have to include each and every type before you can cref it.
- see/seealso with a href instead of a cref are ignored
- Documentation of properties seems to be impossible
(you can only document the set_XXX or get_XXX method)


Jens.
 
Back
Top