You are viewing a plain text version of this content. The canonical link for it is here.

Posted to jira@arrow.apache.org by "Raúl Cumplido (Jira)" <ji...@apache.org> on 2022/04/20 11:07:00 UTC

[jira] [Updated] (ARROW-13414) [C++] Review/apply guidelines for comment tags

     [ https://issues.apache.org/jira/browse/ARROW-13414?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Raúl Cumplido updated ARROW-13414:
----------------------------------
    Fix Version/s: 9.0.0
                       (was: 8.0.0)

> [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: 9.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.20.7#820007)