[
https://issues.apache.org/jira/browse/ARROW-13414?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17384399#comment-17384399
]
Eduardo Ponce commented on ARROW-13414:
---------------------------------------
Arrow comments with *XXX* tag seem to be mainly used to indicate something
which should be removed in favor of a PR comment as soon as possible.
W.r.t. to *TODO* comments a useful variant is to link it to the corresponding
JIRA issue (eg., *TODO(ARROW-123456)*).
> [C++] Review/apply guidelines for comment tags
> ----------------------------------------------
>
> Key: ARROW-13414
> URL: https://issues.apache.org/jira/browse/ARROW-13414
> Project: Apache Arrow
> Issue Type: Improvement
> Components: C++
> Reporter: Eduardo Ponce
> Priority: Minor
> Fix For: 6.0.0
>
>
> The google style guide describes best practices for source code comments
> including for [TODO
> comments|https://google.github.io/styleguide/cppguide.html#TODO_Comments].
> Nevertheless, Arrow C++ code contains comments with custom tags (*TODO*,
> *NOTE*, *N.B.*, *XXX*) which are used with varying styles and do not have an
> explicit guideline on their use/meaning.
> It would be good to establish guidelines for allowed custom tags (if any) and
> their use case.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
