0

Obfuscated code and stray code fragments

If your developers start obfuscating the code that you document, the code samples in the topics will suddenly start showing weird stray code fragments. I was briefly very alarmed when this showed up in my help while the installer person was waiting to start the final build, but Richard immediately identified the cause and suggested a cure that fixed the problem.

He said "I would recommend documenting from the non-obfuscated assembly if possible. If that isn’t possible, you should exclude attributes using the attributes filter on the .NET Options page in Document! X."  

I needed an immediate fix, so I cleared the Attributes check box on the .NET Options page, rebuilt, and my help topics were back to normal again. Naturally, nobody had noticed the problem during the doc review.

 

1 comment

Please sign in to leave a comment.