styleguide/styleguide.md

   1 # Chromium coding style
   2
   3 ## Main style guides
   4
   5 *   [Chromium C++ style guide](c++/c++.md)
   6     *   [Modern C++ use](c++/c++-features.md) for allowed/banned features.
   7     *   See also: [C++ Dos and Don'ts](c++/c++-dos-and-donts.md) for Chromium
   8         best-practices.
   9 *   [Chromium Objective-C style guide](objective-c/objective-c.md)
  10 *   [Chromium Swift style guide](swift/swift.md)
  11 *   [Java style guide for Android](java/java.md)
  12 *   [Chromium Python style guide](python/python.md)
  13 *   [GN style guide](https://gn.googlesource.com/gn/+/main/docs/style_guide.md)
  14     for build files.
  15     *   See also: [Writing GN templates](../build/docs/writing_gn_templates.md)
  16         for Chromium best-practices.
  17 *   [Markdown guide](https://www.chromium.org/developers/markdown-documentation)
  18
  19 Chromium also uses these languages to a lesser degree:
  20
  21 *   [Kernel C style](https://www.kernel.org/doc/html/latest/process/coding-style.html)
  22     for ChromiumOS firmware.
  23 *   [IDL](https://sites.google.com/a/chromium.org/dev/blink/webidl#TOC-Style)
  24 *   [Jinja style guide](https://sites.google.com/a/chromium.org/dev/developers/jinja#TOC-Style)
  25     for [Jinja](https://sites.google.com/a/chromium.org/dev/developers/jinja)
  26     templates.
  27
  28 Regardless of the language used, please keep code
  29 [inclusive for all contributors](inclusive_code.md).
  30
  31 ## Web languages (JavaScript, HTML, CSS)
  32
  33 When working on Web-based UI features, consult the
  34 [Web Development Style Guide](web/web.md) for the Chromium conventions used in
  35 JS/CSS/HTML files.
  36
  37 Internal uses of web languages, notably "layout" tests, should preferably follow
  38 these style guides, but it is not enforced.