Which C# XML documentation comment tag is used for 'true', 'false' and 'null'?

c# styles literals xml-documentation
DavidRR picture DavidRR · Jan 23, 2014 · Viewed 9.9k times · Source

Which C# XML documentation comment tag is used for the literals true, false and null?

In Microsoft's own documentation, these literals appear in bold text. For example, the documentation for the property ArrayList.IsFixedSize appears as:

true if the ArrayList has a fixed size; otherwise, false. The default is false.

None of Microsoft's Recommended Tags seem to apply to this situation. The best fit appears to be <c>, however <c>true</c> appears as true when the documentation is rendered by Doxygen.

However, using <b>true</b> with Doxygen yielded bold text as I surmised that it might. But that leaves me wondering about the portability of using standard HTML tags with other documentation generation tools such as Sandcastle and GhostDoc.

Answer

Gargoyle picture Gargoyle · Sep 17, 2018

You should use the <see langword="true"/> entry so that it works right for whatever language is being used.

Related questions

Setting Button FlatStyle in WPF

I have just been learning about how styles and control templates in WPF can affect the appearance of buttons, I'm trying to set the Button's FlatStyle, in the resources I've seen I can't find anything that tells me how I …

Read More
How to assign a dynamic resource style in code?

I want to produce in code the equivalent of this in XAML: <TextBlock Text="Title:" Width="{Binding FormLabelColumnWidth}" Style="{DynamicResource FormLabelStyle}"/> I can do the text and the width, but how do I assign the dynamic resource to …

Read More
Creating a Style in code behind

Does anyone know how to create a wpf Style in code behind, I can't find anything on the web or MSDN docs. I have tried this but it is not working: Style s = new Style(typeof(TextBlock)); s.RegisterName("Foreground", …

Read More