How do I remove internal/private elements from my XML Documentation files?
-
I am working on an SDK. Obviously I am very happy with the ability to create documentation from code comments. This is useful for both Intellisense and Documentation. We are using Sandcastle to produce the chm file. Sandcastle allows me to filter out internal and private elements. Unfortunately they are in the XML generated by csc.exe which means they show up in Intellisense. I don't see anyway to filter the output of csc. Can I use Sandcastle to filter the docs? How do other people do this?
Tanks for your support
Pat O
Blog_ _ _
/*\== /*\== /*\==
<ooo> <ooo> <ooo> -
I am working on an SDK. Obviously I am very happy with the ability to create documentation from code comments. This is useful for both Intellisense and Documentation. We are using Sandcastle to produce the chm file. Sandcastle allows me to filter out internal and private elements. Unfortunately they are in the XML generated by csc.exe which means they show up in Intellisense. I don't see anyway to filter the output of csc. Can I use Sandcastle to filter the docs? How do other people do this?
Tanks for your support
Pat O
Blog_ _ _
/*\== /*\== /*\==
<ooo> <ooo> <ooo>Don't write any. Your classes should be small enough that you don't need to anyway. Just use regular comments.
-
Don't write any. Your classes should be small enough that you don't need to anyway. Just use regular comments.
Are you suggesting that I do not put comments on internal/private methods? I appreciate that methods should be apparent and "self documenting", but this is no help unless you are reading the code. I find the answer that I should just read the code (instead of relying on documentation) is not very practical.
Tanks for your support
Pat O
Blog_ _ _
/*\== /*\== /*\==
<ooo> <ooo> <ooo> -
Are you suggesting that I do not put comments on internal/private methods? I appreciate that methods should be apparent and "self documenting", but this is no help unless you are reading the code. I find the answer that I should just read the code (instead of relying on documentation) is not very practical.
Tanks for your support
Pat O
Blog_ _ _
/*\== /*\== /*\==
<ooo> <ooo> <ooo>That's why I added, "Just use regular comments."
-
That's why I added, "Just use regular comments."
I guess I did not make myself clear. We have "internal" developers and "external" developers. That is to say we have a team that is working on the SDK and then there are the SDK customers. I want Intelliscense and popup help for the internal developers, but not for external ones. So is there a way I can remove the comments for internal and private, that I can use for one configuration of the solution "retail" and leave in for other configurations ("debug" and "release"). BTW, at this point I assume the answer is no.
Tanks for your support
Pat O
Blog_ _ _
/*\== /*\== /*\==
<ooo> <ooo> <ooo> -
I guess I did not make myself clear. We have "internal" developers and "external" developers. That is to say we have a team that is working on the SDK and then there are the SDK customers. I want Intelliscense and popup help for the internal developers, but not for external ones. So is there a way I can remove the comments for internal and private, that I can use for one configuration of the solution "retail" and leave in for other configurations ("debug" and "release"). BTW, at this point I assume the answer is no.
Tanks for your support
Pat O
Blog_ _ _
/*\== /*\== /*\==
<ooo> <ooo> <ooo>You could write your own tool that would skip the internal and private ones. Oh, wait, intellisence won't show documentation for the parts they can't see anyway. I thought you were asking about the generated XML file.
-
You could write your own tool that would skip the internal and private ones. Oh, wait, intellisence won't show documentation for the parts they can't see anyway. I thought you were asking about the generated XML file.
-
I was. Doesn't intelliscense use the XML?
Tanks for your support
Pat O
Blog_ _ _
/*\== /*\== /*\==
<ooo> <ooo> <ooo>Not the (optional) XML file generated during a build. I wonder whether or not conditional compilation would help:
# if InternaldBuild
<summary>... </summary>endif
internal void F () ...