Git Product home page Git Product logo

Comments (4)

jbt avatar jbt commented on July 16, 2024

IIRC this was because SASS has its quirk of using /* to open single-line comments as well as multi-line comments and at the time I didn't have the time to figure out how to make it behave properly, so this was the safe bet without breaking stuff really badly in the case that there were any /* single-line ocmments

from docker.

jasonseney avatar jasonseney commented on July 16, 2024

Ahh I see, I've never used single line /*... */ syntax in SCSS so wouldn't have noticed if it was broken.

I'll try to take a look into this more and loop back.

from docker.

jasonseney avatar jasonseney commented on July 16, 2024

SASS does allow /* on one line, however they don't really encourage it specifically. SASS Comment Reference.

The only thing I see special, is that they strip out the // syntax and retain comments with /* syntax when building the resulting CSS file.

I updated with the following and tested without any issues:

scss: {
    extensions: [ 'scss' ],
    comment: '//', multiLine: [ /\/\*\*?/, /\*\// ], jsDoc: true
},

and tested with the following SCSS code:

/* # Test file
 * This is a test `SCSS` file
 */
body {
    color: black; // This works
}

// Multi line comment,  
// in single line format.  
// SASS will _strip_ this.
p {
    font-size: 14px;
}

/* Single line of **multiline** syntax */
blockquote {
    text-decoration: italic;
}

The generated documentation skips over single line /* syntax, which I think is alright. This also matches the behavior of the same syntax in the PHP docker documentation.

from docker.

jasonseney avatar jasonseney commented on July 16, 2024

Resolved by merging in referenced pull request.

from docker.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.