[docs] Add Comment Style Guide

[AdarshRawat1]

Fixes Issue -

• Choosing a consistent commenting style for core parts of the compiler. #4563

Based on discussion

• Implement Consistent Commenting Style in backend #4568 (comment)

Task done

• Added guidelines on the commenting style convention to be used for documenting the codebase
• Linked the commenting style guide with the coding convention section

Follow-up Discussion

Should wo include this section somewhere around the Coding Conventions section

[fruffy]

Looks good, thanks! Maybe we should hint at this style guide in the top-level README, too.

[AdarshRawat1]

Looks good, thanks!

Thank you Sir.

Maybe we should hint at this style guide in the top-level README, too.

What would be the optimal approach for that?

1. Add it under the Source File section

2. Shift How to Contribute section to top level README file and then adding the link to all resources under it.

This way we can link the commenting guides, Unit testGuides, Documentation and coding guides at one place for easy access

p4c/docs/README.md

Lines 89 to 95 in f8df27f

	# How to contribute
	* do write unit test code
	* code has to be reviewed before it is merged
	* make sure all tests pass when you send a pull request
	* make sure `make cpplint` produces no errors (`make check` will also run this)
	* write documentation

3. We can either place it under the Development tools.

But it already has a link to the README file containing all the guides

[fruffy]

"How to contribute" should definitely be more prominent at the top-level. I will merge this but feel free to do a follow-up, if you would like to.

[AdarshRawat1]

"How to contribute" should definitely be more prominent at the top-level.

Then, I'll shift it to the top level.

I will merge this but feel free to do a follow-up, if you would like to.

I'll submit a follow-up PR by EOD.