search

DerrickBrayanClayton / protobuf-net

Automatically exported from code.google.com/p/protobuf-net
0 stars 0 forks source link

Include .proto comments into autogenerated .cs #112

Open GoogleCodeExporter opened 8 years ago

GoogleCodeExporter commented 8 years ago 
It would be very useful for documentation in the .proto file to be included in 
the autogenerated .cs file so that it is displayed by VS intellisense. For 
example, documenting the meaning of enum values so that they can be correctly 
used by the consuming C# code.

A naive implementation would be to copy the text of preceeding C-style comment 
lines in the .proto file into the XML-style C# comments, or if this causes 
problems, use a special comment character similar to JavaDocs to trigger 
ingestion by protobuf-net.

Cheers.

Original issue reported on code.google.com by richardw...@googlemail.com on 8 Jun 2010 at 11:46

GoogleCodeExporter commented 8 years ago 
I agree entirely. However, last time I looked, the "protoc" parser tool [by 
google] doesn't include these in the output. This means to do this would 
require writing a .proto parser from scratch. Doable, but not a small job.

Original comment by marc.gravell on 8 Jun 2010 at 7:01