Implement method documentation tags. #10
Conversation
A documentation tag defines a JSON representation of a map that is available to a template via the Docs property of a Method node. There are no constraints on how it is used but, for example, it could define hints about how/if parameters/results should be logged.
| Interface methods can be preceded by documentation comments with gowrap tags to define a map that a template can use to modify its code generation. | ||
| For example, this might be used to indicate to a template generating logging decorators that password values should not be logged: | ||
| ``` | ||
| //+gowrap: {"Log":{"pass":"xxxxx"}} |
There was a problem hiding this comment.
@sjames-iberis I don't really like JSON annotations in Go code.
I think in most of the cases it's enough to just use multiple annotations for that. Just an example:
//+gowrap: pass skip-loging
//+gowrap: pass some-other-option
//+gowrap: ctx skip-loggingOr alternatively:
//+gowrap: pass skip-loging, some-other-option
//+gowrap: ctx skip-loggingIn this case such annotations can be placed in a map:
map[string][]string{
"pass": []string{"skip-logging", "some-other-option"},
}So you can access it from the code.
Also I recently implemented template vars that can be passed from the command line via -v flag maybe it can work better for you so there will be no need to spoil the methods' comments in the code?
Instead you can just pass any number of variables from the command line:
gowrap gen -p io -i Writer -t log -o writer_with_log.go -v pass=skip-logging
There was a problem hiding this comment.
Also take a look at this issue #9
There's similar problem but the solution is more generic.
A documentation tag defines a JSON representation of a map that is available to a template via the Docs property of a Method node.
There are no constraints on how it is used but, for example, it could define hints about how/if parameters/results should be logged.