+ 1
What kind of writing style do you use when documenting your code? What kind of phrases and grammar do you use to convey ideas?
I just wanted to collect people's thoughts on code documentation and technical writing. I primarily use C# and have been using the comment function in Visual Studio 2015 to fill in my XML documentation comments. I've been developing a writing style and wanted to see what other peoples' experience is like. Maybe we can come up with a list of keywords and phrases that are clear and concise for good documentation? Thanks.
1 Answer
+ 1
I've been using phrases like Gets..., Sets..., Provides..., Handles... (haven't used this one yet but it is a thought), Validates..., Parses..., etc. to start my summary sentences. For parameters, I use "String value...", "Boolean flag...", "Integer value...", etc. to start my purpose descriptions and also my "Returns" statements. Thanks.