On 10/14/24 07:56, Farhan Tariq Janjua via discuss wrote:
> I have a few questions regarding comment length in code:
>
> 1.
>
> Is it permissible for a comment (either single-line or multi-line) to>
> exceed 75 characters on a single line?
>
> 2.
>
> In the case of structure members, can the comment associated with a
> member> exceed 75 characters?
>
> 3.
>
> When considering the length of the line in question 2, should the
> character
> count include only the structure member itself, or should it encompass
> both> the member and its associated comment? For example, in the
> following structure
> definition:
>
> struct car {
> char *name; /* the name of the car, also consider this comment length
> to be more than 75 charcters */
> ...
> };
>
>
> How should the character count be determined?
Style is for lines in the file, it doesn't generally matter is that a code or
a comment.
Unless you have some sort of diagrams or something else that would look bad
with shorter lines, both the comments and the code should generally be limited
to 79 characters, according to the coding style document.
You may run ./utilities/checkpatch.py script on your code to make sure there
are no line length warnings.
Also, non-trivial comments should be complete sentences, i.e. start with
a capital letter and end with a dot.
See some more details and examples here:
https://docs.openvswitch.org/en/latest/internals/contributing/coding-style/#comments
Best regards, Ilya Maximets.
_______________________________________________
discuss mailing list
disc...@openvswitch.org
https://mail.openvswitch.org/mailman/listinfo/ovs-discuss
