c# - Proper usage of XML inline documentation for derived classes? -


while think understand why inline xml documentation (i.e. using 3 slashes - ///) isn't working me, i'd guidance on how work around "problem".

i have interface, , 2 derived classes. 1 derived class simulation, , other talking real hardware.

it's hardware implementation special simulator doesn't need do. have xml documentation hardware methods, , not simulator. however, when hover on method name, don't documentation in tooltip @ all, presumably because xml docs aren't associated interface.

this makes sense, , plan put documentation in interface instead , live it. still curious, though... how else this? there magical way make tooltip aggregate of valid xml docs? in other words, since compiler doesn't know derived class being used, there way show xml docs classes implement interface?

this won't solve problems ghostdoc can insert documentation derived class using base class documentation. it's worth taking anyway if you're doing xml documentation.


Comments

Popular posts from this blog

c# - how to write client side events functions for the combobox items -

exception - Python, pyPdf OCR error: pyPdf.utils.PdfReadError: EOF marker not found -