Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Comment parsing #16

Open
bnhovde opened this issue Feb 23, 2015 · 1 comment
Open

Comment parsing #16

bnhovde opened this issue Feb 23, 2015 · 1 comment

Comments

@bnhovde
Copy link

bnhovde commented Feb 23, 2015

Hi,

It would be really helpful with some config options for the comments parser.

I'd love to use this for my projects but don't fancy changing my team's commenting style for it to work.

Here's an scss example module, whos comment won't be read. (probably due to the first line being blank)

// *************************************
//
//   Example module
//   -> Overview of module and usage
//
// *************************************

// -------------------------------------
//   Base
// -------------------------------------

.module {

    // -------------------------------------
    //   Variables
    // -------------------------------------

    $module-var:    7em;
    $module-col-fg: #3B5998;
    $module-col-bg: #c0deed;


    // -------------------------------------
    //   Elements
    // -------------------------------------


    // ----- Element description ----- // 

    &__element {}


    // -------------------------------------
    //   Variations
    // -------------------------------------


    // ----- Variation description ----- // 

    &--variation {}

}
@brunowego
Copy link

Another style of comment based on CSS Guidelines:

/**
 * MAIN
 */

or

/*------------------------------------*\
    #MAIN
\*------------------------------------*/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants