ariatosca-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Tal Liron (JIRA)" <j...@apache.org>
Subject [jira] [Created] (ARIA-331) Remove "region" and "endregion" comments
Date Thu, 27 Jul 2017 23:25:00 GMT
Tal Liron created ARIA-331:
------------------------------

             Summary: Remove "region" and "endregion" comments
                 Key: ARIA-331
                 URL: https://issues.apache.org/jira/browse/ARIA-331
             Project: AriaTosca
          Issue Type: Story
            Reporter: Tal Liron


These add bulk rather than clarity.

The convention is to comment at the beginning of a block, no need to "close" it and definitely
not use confusing keywords that seem to belong to an IDE or preprocessor.

So:
{code}
# one-to-one relationships
...
{code}
Instead of:
{code}
# region one-to-one relationships
...
# endregion
{code}




--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

Mime
View raw message