Back to Community Threads
1
Repeated references
Problem reported by Mascaro Angelo - 11/7/2018 at 11:48 PM
Resolved
I tested the help generation on a project and I discovered that some sentences are repeated. I checked the XML comments and I found no repetition. Here an example:
In the source file there is written:
	/// <seealso cref="System.Windows.Forms.Form" />
	/// <seealso cref="System.ComponentModel.INotifyPropertyChanged" />
and this is the screen capture of the help file
 

3 Replies

Reply to Thread
0
Mascaro Angelo Replied
11/8/2018 at 12:03 AM
Another example:
0
Misha Zhutov Replied
11/8/2018 at 2:52 AM
Employee Post
Hello,

Are those classes are partial? And each partial type declaration has XML comment with <seealso> tag? If MainForm, for example has two class declarations (in MainForm.cs and MainForm.Designer.cs files) then it will display XML comments from both.
So, for partial types please always use XML comments in one type declaration.
0
Serge B. Replied
11/14/2018 at 1:50 PM
Employee Post
Hi Mascaro,
 
These classes are they partial?
 
If so, does each partial type declaration has XML comment with <seealso> tag?
 
If MainForm, for example, has two class declarations (in MainForm.cs and MainForm.Designer.cs files) then it will display XML comments from both.

So, for partial types please always use XML comments in one type declaration.
 
Thanks!
Serge Baranovsky
SubMain Software
(800) 936-2134
Back to Community Threads

Reply to Thread