HomePhabricator

[NFC] Remove ASCII lines from comments

Authored by JDevlieghere on Apr 10 2019, 1:48 PM.

Description

[NFC] Remove ASCII lines from comments

A lot of comments in LLDB are surrounded by an ASCII line to delimit the
begging and end of the comment.

Its use is not really consistent across the code base, sometimes the
lines are longer, sometimes they are shorter and sometimes they are
omitted. Furthermore, it looks kind of weird with the 80 column limit,
where the comment actually extends past the line, but not by much.
Furthermore, when / is used for Doxygen comments, it looks
particularly odd. And when
is used, it incorrectly gives the
impression that it's actually a Doxygen comment.

I assume these lines were added to improve distinguishing between
comments and code. However, given that todays editors and IDEs do a
great job at highlighting comments, I think it's worth to drop this for
the sake of consistency. The alternative is fixing all the
inconsistencies, which would create a lot more churn.

Differential revision: https://reviews.llvm.org/D60508

llvm-svn: 358135

Details

Committed
JDevlieghereApr 10 2019, 1:48 PM
Differential Revision
D60508: [NFC] Remove ASCII lines from comments
Parents
rG66b6bb1766b3: Check i < FD->getNumParams() before querying
Branches
Unknown
Tags
Unknown