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-597669642
 
 
   The issue here is just a nxstyle bug at line 1474.  But thinking more about 
the larger question, "Should comments be allowed in parameter lists?" this 
think that the answer has to be YES.  After reconsideration I realize that that 
is actually done quite often.  The example case at hand is perverse, but 
parameter commenting like the following is very common and should be permitted 
(in both actual and formal parameters):
   
       int foobar(int a,                    /* This is parameter a */
                  int b,                    /* This is parameter b */
                  int c);                   /* This is parameter c */
   
   I have done that a few times myself when the values passed as actual 
parameters are not clear.  It is probably not a good thing to do for formal 
parameters since these should be document in the "Input Parameters" section of 
the function header, not in the parameter list.  However, many people do that.
   

----------------------------------------------------------------
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:
[email protected]


With regards,
Apache Git Services

Reply via email to