protoc-gen-doc
protoc-gen-doc copied to clipboard
Ignore comments
Ignore comments not intuitive and unreliable. Filtering before each logical assignment is necessary.
I miss that #8 simple behavior! Ignore all comments with // or /* ... */ would be correct!
And the option @exclude is buggy.
message Test {
// @exlcude only that comment should be hidden
/// A valid comment
optional uint32 fail1= 1;
// @exlcude only that comment should be hidden
/** A valid comment */
optional uint32 ok = 2;
/// A valid comment
// @exlcude only that comment should be hidden
optional uint32 fail2 = 3;
/** A valid comment */
// @exlcude only that comment should be hidden
optional uint32 fail3 = 4;
}
Field-Description Result:
- fail1: ""
- ok: "A valid comment"
- fail2: " A valid comment @exlcude only that comment should be hidden"
- fail3: ""
From fail3 to ok, only the comment order changed!