You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Thrift supports adding javadoc style comments to Thrift IDL files, and including the documentation in the generated code. If we take the following Thrift definition:
/** * Describes the different types of user.*/enumUserType {
/** * Represents an administrator.*/Administrator
}
It might end up generating the following code:
/// <summary>/// Describes the different types of user./// </summary>publicenumUserType{/// <summary>/// Represents an administrator./// </summary>Administrator}
Things to consider:
I think the Thrift compiler only supports adding basic summaries to elements, rather than documenting params, exceptions, return types, etc.
It only supports javadoc comments. We could also support C# XML comments to make it more familiar to C# developers.
The text was updated successfully, but these errors were encountered:
Thrift supports adding javadoc style comments to Thrift IDL files, and including the documentation in the generated code. If we take the following Thrift definition:
It might end up generating the following code:
Things to consider:
The text was updated successfully, but these errors were encountered: