nuttx-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] [incubator-nuttx] patacongo commented on issue #540: possible nxstyle false alarm: "Missing space before closing C comment"
Date Wed, 11 Mar 2020 13:48:59 GMT
patacongo commented on issue #540: possible nxstyle false alarm: "Missing space before closing
C comment"
URL: https://github.com/apache/incubator-nuttx/issues/540#issuecomment-597645658
 
 
   
   > I see, but can you please share your opinion concerning comments inside statements
that is not commented out code but perhaps an explanation?
   > 
   > `call(int a /* This is an integer */ );`
   
   If it is not prohibited, then it is permitted.  Providing it does not conflict with common
sense, acceptable practice.  And if it conflicts with common sense, acceptable practice then
it should be prohibited.
   
   I don't have a strong opinion in this case.  I would not comment in that way[1].  And would
raise my eybrows to see such commenting.
   
   Ultimately coding standards come down to aesthetics.  But the coding standard must be commonly
applied for good software quality.  So those aesthetics need to be formalized and made standard
.. cast in concrete.  If they are not so formalized, then it is left as a matter of personal
preference UNLESS you do want to formalilze it.
   
   If you want to forbid comments in the argument lists, I will support that but then you
should also submit a PR against Documentation/NuttXCCodingStandard.html.  That is the master
coding standard, the version on the website is a copy.
   
   Greg
   
   [1] CAVEAT:  I don't normally comment this way, but I am the culprit in the example we
were discussing.  In this case, I just left some commented out stuff left over from debug.
 I still think that the commented out code is correct but it is commented out because it didn't
work and I forgot to remove the comments.
   
   In #542 I kept the question but moved it out of the argument list and marked it clearly
with REVISIT:
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

Mime
View raw message