locked
How can I adding comments to winmd files??

    Question

  • Now I have implement a winRT component and create a related file but I want to add comments to winmd files. Is any way to achieve this??

    For example, there is a structure below

        public ref struct A sealed
        {
            A();
            virtual ~A();

            property int strength;
        };

    I want to tell user the range of strength is only 0 ~100, how can I add comment to let users know this??

    Directly adding comment behind the variable is not available.

     
    Thursday, August 29, 2013 2:37 AM

All replies

  • Hi Kenny,

    Above the property or function simply add the summary tag like this:

      public sealed class Class1
        {
            /// <summary>
            /// This is a cool function
            /// </summary>
            public void myCoolFunc()
            {
            }
        }

    This will cause that description to show in the object browser and intelli-sense.

    Jeff


    Jeff Sanders (MSFT)

    @jsandersrocks - Windows Store Developer Solutions @WSDevSol
    Getting Started With Windows Azure Mobile Services development? Click here
    Getting Started With Windows Phone or Store app development? Click here
    My Team Blog: Windows Store & Phone Developer Solutions
    My Blog: Http Client Protocol Issues (and other fun stuff I support)

    Thursday, August 29, 2013 2:51 PM
    Moderator
  • Dear Jeff:

    Thanks for your reply. I have tried your method but it seems I can see the description only under my module. It is invisible on the APP layer who use our module. Am I missing something or??

    My application performs like description below and I hope this is helpful for this question.

    1. I will create a module.dll and module.winmd through our projects

    2. APP layer will use our .winmd file to reference our module.

    I want to let developers of APP layer can know the range of those properties, so I am wondering is there any method I can expose this information under .winmd file or in other ways.

    Friday, August 30, 2013 9:06 AM