Documenting has never been so easy
Generate API documentation for your C# and VB .NET code

Sometimes, the links that point to topics inside the document don't work in generated docx. When you click the link, you'll be redirected to the start of the document.

VSdocman assigns a bookmark to each topic. A link to a topic is then created as a cross-reference to such a bookmark. A bookmark name is generated from a member name using File Names settings. If you use default Numeric file names, the bookmark name will have a short numeric form. You can see it when you hover over the link.



If you, however, use Pretty file names, the bookmark name will be constructed from code member's full name and this can lead to a quite long bookmark name.



But MS Word has a limit of 40 characters for bookmark names. If you exceed that limit, you'll get the behavior described above.

Solution

Always use  Numeric file names when you generate docx format.

 

Start generating your .NET documentation now!

DOWNLOAD

Free, fully functional trial

A few years ago, we gave a test to several products to document our source code. We finally chose VSdocman mostly because it was easy to use, from within the development environment, making training of programmers useless. It provides flexible features which enables producing complete documentation for people using our products and also for internal use. When technical support is required (we needed this when switching to VS 2015), Peter answered our emails very quickly. After more than 3 years with VSdocman, we strongly recommend the product which is amazingly easier to use than SandCastle.

Pierrick Combreau, Product Manager, Quotalys Ltd

Cookies user preferences
We use cookies to ensure you to get the best experience on our website. If you decline the use of cookies, this website may not function as expected.
Accept all
Decline all
Marketing
Set of techniques which have for object the commercial strategy and in particular the market study.
Quantcast
Accept
Decline
Save