Menu
I understand that remarks tag is used to provide additional information about the class but it is not displayed in intellisense while hovering / calling that class. I would like to know Where exactly it is useful?
513
They are human readable words intended to make the code readable. Comments are completely ignored by the compiler. In C#, there are 3 types of comments: Single Line Comments ( // ) Multi Line Comments ( /* */ )
Remarks are used to customize the printouts of documents such as the invoice, itinerary, and ITR. There are two types of remark: PNR remarks: These remarks are created directly in the PNR. They are always printed, and they contain either amounts that modify the invoice totals or free-flow text.
A documentation file is used as input to a documentation viewer; a tool intended to produce some sort of visual display of type information and its associated documentation. A conforming C# compiler is not required to check the syntax of documentation comments; such comments are simply ordinary comments.
Documentation comments are similar to C# single-line comments, but start with /// (that's three slashes), and can be applied to any user-defined type or member. As well as containing descriptive text, these comments can also include embedded XML tags.
Remarks are used for building a documentation file. They are used for more detailed comments, adding supplemental information to the "summary" tag ("summary" tag does show in intellisense).
The generated documentation file will be in XML format.
To generate the documentation file you need to add the "/doc" compiler option. In visual studio you can enable the generation of XML documentation file by:
64
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
