Skip to content

Latest commit

 

History

History
75 lines (41 loc) · 1.16 KB

section-comment.md

File metadata and controls

75 lines (41 loc) · 1.16 KB

Section comment

2020-07-21 -> 2021-03-19

A section comment (aka section header comment) is a comment that looks like this in a php file:

<?php

//--------------------------------------------
// MY SECTION
//--------------------------------------------

The section header comment looks like this in a babyYaml file:

# --------------------------------------
# MY SECTION
# --------------------------------------

A section header comment is basically composed of the following sequence of lines:

  • a dash line
  • a title line
  • a dash line

A section is composed of the following elements:

  • a section header comment
  • the section content

Sections end when either of those is true:

  • the file ends
  • the section header comment of the next section starts

Here is an example of different sections in a babyYaml file.

# --------------------------------------
# Ling.Light_Kit_Admin
# --------------------------------------
pou
pou
pou


# --------------------------------------
# Ling.XX
# --------------------------------------
pou
dji
pou