How to refer to array types in documentation comments

Question

I just posted this question and learned about <see cref="">, however when i tried

/// This is a set of extensions that allow more operations on a <see cref="byte[]"/>.

The compiler gave me warnings about it not being formatted correctly. What do I need to do so it will see the code reference correctly?

I don't think this is an objection to [] per se, more about the compiler not being able to recognise `byte[]` as a linkable type. I've changed the title of your question to reflect this: please roll back if you disagree or think I'm wrong. — itowlson, Mar 02 '10 at 22:56

score 63 · Accepted Answer · edited May 23 '17 at 12:34

63

As described in this post, use

 <see cref="T:byte[]" />

edited May 23 '17 at 12:34

Community

answered Mar 02 '10 at 23:02

Timores

4

I was trying to do this with `T:string[]`, and it wasn't working. `Array.string` seemed to work. – zzzzBov Jun 14 '13 at 15:24

score 4 · Answer 2 · answered Aug 16 '17 at 10:57

4

You can write like this:

/// <summary>
/// Array byte <see cref="byte"/>[]
/// Nullable byte <see cref="byte"/>?
/// </summary>

or

/// <summary>
/// Array byte <see cref="T:byte[]"/>
/// Nullable byte <see cref="T:byte?"/>
/// </summary>

answered Aug 16 '17 at 10:57

Mr.Scazy

score -2 · Answer 3 · answered Mar 02 '10 at 23:01

-2

You should perhaps have <summary>...</summary> around:

/// <summary>
/// This is a set of extensions that allow more operations on a <see cref="byte[]"/>.
/// </summary>

answered Mar 02 '10 at 23:01

Vlad

I did but i cut it from the example because i didn't want to type 3 lines. – Scott Chamberlain Mar 02 '10 at 23:43

3 Answers3