Generate documentation - return value

2 posts, 0 answers
  1. Wolfgang
    Wolfgang avatar
    98 posts
    Member since:
    Oct 2012

    Posted 19 Jul 2013 Link to this post

    I used GhostDoc alot. GhostDoc has filled some values for methods with return values.

    Is it possible (or somewhere configurable) that JustCode also generates info for return values?

    Best regards,
    Wolfgang

    Example:
    private static bool HasAttribute(PropertyInfo propertyInfo, string attributeName)
    {
        ...
    }

    JustCode will generate:
    /// <summary>
    /// Determines whether the specified property info has attribute.
    /// </summary>
    /// <param name="propertyInfo">The property info.</param>
    /// <param name="attributeName">Name of the attribute.</param>
    /// <returns></returns>

    The output of GhostDoc will give a bit more information:
    /// <summary>
    /// Determines whether the specified property info has attribute.
    /// </summary>
    /// <param name="propertyInfo">The property info.</param>
    /// <param name="attributeName">Name of the attribute.</param>
    /// <returns>
    ///   <c>true</c> if the specified property info has attribute; otherwise, <c>false</c>.
    /// </returns>
  2. Zdravko
    Admin
    Zdravko avatar
    657 posts

    Posted 23 Jul 2013 Link to this post

    Hello Wolfgang,

     Thanks for contacting us.
    We have some improvement plans regarding the Generate Documentation feature, but most probably for some of the next Qs.
    GhostDoc is specialized in generating documentation and this is in what they are good. The main idea of our feature is to provide a base documentation frame which the user could easily attune to his needs.
    Maybe we can add the type of the return value to the info if that will help.
    However we will discuss it within the team.
    Thanks.

    Regards,
    Zdravko
    Telerik
    Share what you think about JustCode with us, so we can help you even better! You can use the built-in feedback tool inside JustCode, our forum, or our JustCode feedback portal.
  3. DevCraft banner
Back to Top