readmongo/node_modules/comment-patterns/docs/languages.md

The database

These are the base entries (no variations) of the database:

C

{
  srcFile: "c.js",
  name: "C",
  nameMatchers: [".c", ".h"],
  multiLineComment: [{
    start: /\/\*\*/,
    middle: "*",
    end: "*/",
    apidoc: true
  }, {
    start: /\/\*/,
    middle: "*",
    end: "*/"
  }],
  singleLineComment: [{
    start: "//"
  }]
}

Clojure

{
  srcFile: "clojure.js",
  name: "Clojure",
  nameMatchers: [".clj", ".cljs"],
  singleLineComment: [{
    start: ";;"
  }]
}

CoffeeScript

{
  srcFile: "coffeescript.js",
  name: "CoffeeScript",
  nameMatchers: [".coffee", "Cakefile"],
  multiLineComment: [{
    start: "###*",
    middle: / \*|#/,
    end: "###"
  }, {
    start: "###",
    middle: "#",
    end: "###"
  }],
  singleLineComment: [{
    start: "#"
  }]
}

C++

{
  srcFile: "cplusplus.js",
  name: "C++",
  nameMatchers: [".cpp", ".hpp", ".c++", ".h++", ".cc", ".hh", ".cxx", ".hxx"],
  multiLineComment: [{
    start: /\/\*\*/,
    middle: "*",
    end: "*/",
    apidoc: true
  }, {
    start: /\/\*/,
    middle: "*",
    end: "*/"
  }],
  singleLineComment: [{
    start: "//"
  }]
}

CSharp

{
  srcFile: "csharp.js",
  name: "CSharp",
  nameMatchers: [".cs"],
  multiLineComment: [{
    start: /\/\*\*/,
    middle: "*",
    end: "*/",
    apidoc: true
  }, {
    start: /\/\*/,
    middle: "*",
    end: "*/"
  }],
  singleLineComment: [{
    start: "//"
  }]
}

CSS

{
  srcFile: "css.js",
  name: "CSS",
  nameMatchers: [".css"],
  multiLineComment: [{
    start: /\/\*\*/,
    middle: "*",
    end: "*/",
    apidoc: true
  }, {
    start: /\/\*/,
    middle: "*",
    end: "*/"
  }]
}

Go

{
  srcFile: "go.js",
  name: "Go",
  nameMatchers: [".go"],
  singleLineComment: [{
    start: "//"
  }]
}

Handlebars

{
  srcFile: "handlebars.js",
  name: "Handlebars",
  nameMatchers: [".handlebars", ".hbs"],
  multiLineComment: [{
    start: "<!--",
    middle: "",
    end: "-->"
  }, {
    start: "",
    apidoc: true
  }, {
    start: ""
  }]
}

Haskell

{
  srcFile: "haskell.js",
  name: "Haskell",
  nameMatchers: [".hs"],
  singleLineComment: [{
    start: "--"
  }]
}

HTML

{
  srcFile: "html.js",
  name: "HTML",
  nameMatchers: [".htm", ".html"],
  multiLineComment: [{
    start: "<!--",
    middle: "",
    end: "-->"
  }]
}

Jade

{
  srcFile: "jade.js",
  name: "Jade",
  nameMatchers: [".jade"],
  singleLineComment: [{
    start: "//"
  }, {
    start: "//-"
  }]
}

Jake

{
  srcFile: "jake.js",
  name: "Jake",
  nameMatchers: [".jake"],
  singleLineComment: [{
    start: "//"
  }]
}

Java

{
  srcFile: "java.js",
  name: "Java",
  nameMatchers: [".java"],
  multiLineComment: [{
    start: /\/\*\*/,
    middle: "*",
    end: "*/",
    apidoc: true
  }, {
    start: /\/\*/,
    middle: "*",
    end: "*/"
  }],
  singleLineComment: [{
    start: "//"
  }]
}

JavaScript

{
  srcFile: "javascript.js",
  name: "JavaScript",
  nameMatchers: [".js"],
  multiLineComment: [{
    start: /\/\*\*/,
    middle: "*",
    end: "*/",
    apidoc: true
  }, {
    start: /\/\*/,
    middle: "*",
    end: "*/"
  }],
  singleLineComment: [{
    start: "//"
  }]
}

JSON

{
  srcFile: "json.js",
  name: "JSON",
  nameMatchers: [".json"]
}

JSP

{
  srcFile: "jsp.js",
  name: "JSP",
  nameMatchers: [".jsp"],
  multiLineComment: [{
    start: "<!--",
    middle: "",
    end: "-->"
  }, {
    start: "<%--",
    middle: "",
    end: "--%>"
  }]
}

LaTeX

{
  srcFile: "latex.js",
  name: "LaTeX",
  nameMatchers: [".tex", ".latex", ".sty"],
  singleLineComment: [{
    start: "%"
  }]
}

LESS

{
  srcFile: "less.js",
  name: "LESS",
  nameMatchers: [".less"],
  singleLineComment: [{
    start: "//"
  }],
  multiLineComment: [{
    start: /\/\*\*/,
    middle: "*",
    end: "*/",
    apidoc: true
  }, {
    start: /\/\*/,
    middle: "*",
    end: "*/"
  }]
}

LiveScript

{
  srcFile: "livescript.js",
  name: "LiveScript",
  nameMatchers: [".ls", "Slakefile"],
  multiLineComment: [{
    start: /\/\*\*/,
    middle: "*",
    end: "*/",
    apidoc: true
  }, {
    start: /\/\*/,
    middle: "*",
    end: "*/"
  }],
  singleLineComment: [{
    start: "#"
  }]
}

Lua

{
  srcFile: "lua.js",
  name: "Lua",
  nameMatchers: [".lua"],
  singleLineComment: [{
    start: "--"
  }]
}

Make

{
  srcFile: "make.js",
  name: "Make",
  nameMatchers: ["Makefile"],
  singleLineComment: [{
    start: "#"
  }]
}

Markdown

{
  srcFile: "markdown.js",
  name: "Markdown",
  nameMatchers: [".md", ".markdown", ".mkd", ".mkdn", ".mdown"],
  commentsOnly: true
}

Mustache

{
  srcFile: "mustache.js",
  name: "Mustache",
  nameMatchers: [".mustache"],
  multiLineComment: [{
    start: ""
  }]
}

Objective-C

{
  srcFile: "objective-c.js",
  name: "Objective-C",
  nameMatchers: [".m", ".mm"],
  multiLineComment: [{
    start: /\/\*\*/,
    middle: "*",
    end: "*/",
    apidoc: true
  }, {
    start: /\/\*/,
    middle: "*",
    end: "*/"
  }],
  singleLineComment: [{
    start: "//"
  }]
}

Perl

{
  srcFile: "perl.js",
  name: "Perl",
  nameMatchers: [".pl", ".pm"],
  singleLineComment: [{
    start: "#"
  }]
}

PHP

{
  srcFile: "php.js",
  name: "PHP",
  nameMatchers: [".php", ".php3", ".php4", ".php5", ".fbp"],
  singleLineComment: [{
    start: "//"
  }]
}

Puppet

{
  srcFile: "puppet.js",
  name: "Puppet",
  nameMatchers: [".pp"],
  singleLineComment: [{
    start: "#"
  }]
}

Python

{
  srcFile: "python.js",
  name: "Python",
  nameMatchers: [".py"],
  singleLineComment: [{
    start: "#"
  }]
}

Ruby

{
  srcFile: "ruby.js",
  name: "Ruby",
  nameMatchers: [".rb", ".ru", ".gemspec"],
  singleLineComment: [{
    start: "#"
  }]
}

Sass

{
  srcFile: "sass.js",
  name: "Sass",
  nameMatchers: [".sass"],
  singleLineComment: [{
    start: "//"
  }]
}

SCSS

{
  srcFile: "scss.js",
  name: "SCSS",
  nameMatchers: [".scss"],
  multiLineComment: [{
    start: /\/\*\*/,
    middle: "*",
    end: "*/",
    apidoc: true
  }, {
    start: /\/\*/,
    middle: "*",
    end: "*/"
  }],
  singleLineComment: [{
    start: "//"
  }]
}

Shell

{
  srcFile: "shell.js",
  name: "Shell",
  nameMatchers: [".sh", ".bash"],
  singleLineComment: [{
    start: "#"
  }]
}

SQL

{
  srcFile: "sql.js",
  name: "SQL",
  nameMatchers: [".sql"],
  singleLineComment: [{
    start: "--"
  }]
}

Swift

{
  srcFile: "swift.js",
  name: "Swift",
  nameMatchers: [".swift"],
  multiLineComment: [{
    start: /\/\*\*?/,
    middle: "*",
    end: "*/"
  }],
  singleLineComment: [{
    start: "//"
  }]
}

TypeScript

{
  srcFile: "typescript.js",
  name: "TypeScript",
  nameMatchers: [".ts"],
  multiLineComment: [{
    start: /\/\*\*/,
    middle: "*",
    end: "*/",
    apidoc: true
  }, {
    start: /\/\*/,
    middle: "*",
    end: "*/"
  }],
  singleLineComment: [{
    start: "//"
  }]
}

YAML

{
  srcFile: "yaml.js",
  name: "YAML",
  nameMatchers: [".yml", ".yaml"],
  singleLineComment: [{
    start: "#"
  }]
}