Partager via

GhostDoc is a great tool for inserting documentation in Visual Studio

  • Article

I've just started trying out GhostDoc. You can select a method and it will fill out the XML document comments for the function. For example, here's what it generated for the CanHorizontallyScroll method from my VirtualizingTilePanel:

        /// <summary>

        /// Gets or sets a value indicating whether this instance can horizontally scroll.

        /// </summary>

        /// <value>

        /// <c>true</c> if this instance can horizontally scroll; otherwise, <c>false</c>.

        /// </value>

        public bool CanHorizontallyScroll

        {

            get { return _canHScroll; }

            set { _canHScroll = value; }

        }

I don't actually understand it's rule system yet, but it seems suprisingly smart. Arguably, if GhostDoc was smart enough to figure out the comments, another developer can probably figure out the same information without the comments, but it's a great starting point for adding more information.