Skip to content
This repository was archived by the owner on Feb 13, 2020. It is now read-only.
This repository was archived by the owner on Feb 13, 2020. It is now read-only.

Standardize comments in files #36

@mtancoigne

Description

@mtancoigne

We need to setup comments standardization in files, to unify the presentation of the code.

Come here to discuss about it.

For config file, I propose the following:

#--------------------------------------------------------------------------
#
# Very big section (general, defaults, plugins, theme)
#
#--------------------------------------------------------------------------
plugin:

  ## --------------------------------------------------------------------------
  ##  Someplugin: description
  ## ----------------------------
  ##  Contains: <controllers list>
  ## --------------------------------------------------------------------------
  ## Extended description,
  ## Extra help for special stuff...
  ## 
  ## Paragraphs separated by an empty line.
  ##
  Someplugin:

    ## --------------------------------------------------------------------------
    ##  Small section description
    ## ----------------------------
    parts:

      ##
      ##
      ## Sub  description
      ##
      ##
      SomePart:

        ##
        ## Sub-sub
        ##
        model:

          ##
          ## Sub-sub-sub section
          options:

            ## Simple line description (two # to know it's a comment for en entry) 
            someStuff: someValue
            ## Multiline
            ## comment.
            someStuff2: someValue

            ## Only one # for commented entries
#           commentedEntry: value  
            #anotherCommentedEntry: value   

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions