File: use-anonymous-namespace.rst

package info (click to toggle)
llvm-toolchain-16 1%3A16.0.6-15~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,634,792 kB
  • sloc: cpp: 6,179,261; ansic: 1,216,205; asm: 741,319; python: 196,614; objc: 75,325; f90: 49,640; lisp: 32,396; pascal: 12,286; sh: 9,394; perl: 7,442; ml: 5,494; awk: 3,523; makefile: 2,723; javascript: 1,206; xml: 886; fortran: 581; cs: 573
file content (46 lines) | stat: -rw-r--r-- 1,503 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
.. title:: clang-tidy - misc-use-anonymous-namespace

misc-use-anonymous-namespace
============================

Finds instances of ``static`` functions or variables declared at global scope
that could instead be moved into an anonymous namespace.

Anonymous namespaces are the "superior alternative" according to the C++
Standard. ``static`` was proposed for deprecation, but later un-deprecated to
keep C compatibility [1]. ``static`` is an overloaded term with different meanings in
different contexts, so it can create confusion.

The following uses of ``static`` will *not* be diagnosed:

* Functions or variables in header files, since anonymous namespaces in headers
  is considered an antipattern. Allowed header file extensions can be configured
  via the `HeaderFileExtensions` option (see below).
* ``const`` or ``constexpr`` variables, since they already have implicit internal
  linkage in C++.

Examples:

.. code-block:: c++

  // Bad
  static void foo();
  static int x;

  // Good
  namespace {
    void foo();
    int x;
  } // namespace

Options
-------

.. option:: HeaderFileExtensions

   A semicolon-separated list of filename extensions of header files (the filename
   extensions should not include "." prefix). Default is ";h;hh;hpp;hxx".
   For extension-less header files, using an empty string or leaving an
   empty string between ";" if there are other filename extensions.

[1] `Undeprecating static <https://www.open-std.org/jtc1/sc22/wg21/docs/cwg_defects.html#1012>`_