XML Documentation in Object Browser
CodeGuru Home VC++ / MFC / C++ .NET / C# Visual Basic VB Forums Developer.com
Results 1 to 4 of 4

Thread: XML Documentation in Object Browser

  1. #1
    Join Date
    Jul 2010
    Posts
    1

    XML Documentation in Object Browser

    I'm trying to document my code and for some reason my example code is not showing up in the object browser window. Should my code show up when I do this?

    Code:
            /// <summary>
            /// <para>The color sensor contains 4 sensors. (C)lear which does not contain a light filter, (R)ed, (G)reen, and (B)lue
            /// which contain filters. CRGB Returns an integer with each byte in the integer containing the level of each filter.</para>
            /// </summary>
            /// <returns>Returns Clear, Red, Green, and Blue contained in a 4 byte integer.</returns>
            /// <example>
            /// <code>
            /// public static void Main()
            /// {
            ///     Colorimeter.ADJD_S371_Q999 myColorSensor = new ADJD_S371_Q999();
            ///
            ///     //Poll the sensor to update the levels
            ///     myColorSensor.Poll;
            ///     
            ///     int rgb = myColorSensor.CRGB;
            ///     int redMask = 0x00ff0000;
            ///     int temp;
            ///     byte level;
            ///    
            ///     //Mask the unused bytes
            ///     temp = (rgb &amp; redMask);
            /// 
            ///     //Shift the bytes so the red byte is in the least signifcant position
            ///     level = (byte)(temp >> 16);
            /// }
            /// </code>
            /// </example>

  2. #2
    Join Date
    Jun 2008
    Posts
    2,477

    Re: XML Documentation in Object Browser

    There is no code there, you have commented all of it out, so no, it will not show up.

  3. #3
    Join Date
    Jan 2010
    Posts
    1,099

    Re: XML Documentation in Object Browser

    I think he's trying to use the <example></example> XML documentation tags to provide an example of how to use some code that's not shown here.

    I don't think that the Object Browser supports these tags. Most of the tags are intended to be used with specialized documentation-generating tools (like NDoc), some of which can produce a set of web-pages similar to the classic MSDN page layout.

  4. #4
    Join Date
    Jul 2010
    Location
    Watch Window
    Posts
    87

    Talking Re: XML Documentation in Object Browser

    I'm trying to document my code and for some reason my example code is not showing up in the object browser window. Should my code show up when I do this?
    yes why did you comment the following code ????please remove commet and run it .and if found any error .tell me ????

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •  


Windows Mobile Development Center


Click Here to Expand Forum to Full Width

This is a CodeGuru survey question.


Featured


HTML5 Development Center