This is a migrated thread and some comments may be shown as answers.

Generate documentation - return value

1 Answer 14 Views
Code Generation
This is a migrated thread and some comments may be shown as answers.
This question is locked. New answers and comments are not allowed.
Wolfgang
Top achievements
Rank 1
Wolfgang asked on 19 Jul 2013, 06:21 AM
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>

1 Answer, 1 is accepted

Sort by
0
Zdravko
Telerik team
answered on 23 Jul 2013, 11:29 AM
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.
Tags
Code Generation
Asked by
Wolfgang
Top achievements
Rank 1
Answers by
Zdravko
Telerik team
Share this question
or