Is it possible to have comments for constants on the same line?
36 views
Skip to first unread message
ojak...@gmail.com
unread,
Aug 17, 2013, 7:34:45 PM8/17/13
Reply to author
Sign in to reply to author
Forward
Sign in to forward
Delete
You do not have permission to delete messages in this group
Copy link
Report message
Sign in to report message
Show original message
Either email addresses are anonymous for this group or you need the view member email addresses permission to view the original message
to yar...@googlegroups.com
One very common commenting practice is to put comments for constants on the same line as the constant itself. However, this freaks out yard. For example:
# Yard wants comments for constants here
MY_CONSTANT = 1234
MY_BRIEF_CONSTANT = 5678 # However, this is super-common, but
# causes all sorts of problems for YARD
My questions:
Is there any way to customize YARD to handle both cases?
If not, is there any way to turn off generation of docs for constants (bummer, but only practical solution for the codebases I'm on)