search

pseudomuto / protoc-gen-doc

Documentation generator plugin for Google Protocol Buffers
MIT License
2.61k stars 462 forks source link

Ignore comments #401

Open ChristianToepfer opened 5 years ago

ChristianToepfer commented 5 years ago

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:

From fail3 to ok, only the comment order changed!