Mirrors/zig
1
0
Fork 0
mirror of https://codeberg.org/ziglang/zig.git synced 2026-04-26 13:01:34 +03:00
Code Issues Packages Projects Releases Wiki Activity

langref: refrain from underscore prefixes

Browse Source
This commit is contained in:
Andrew Kelley
2026-01-17 14:32:14 -08:00
parent 041701416b
commit e5dc5a6eb5
1 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/langref.html.in
+12
View File
@@ -7134,6 +7134,18 @@ coding style.
cannot be any more specific without being incorrect.</p>
{#header_close#}
{#header_open|Refrain from Underscore Prefixes#}
<p>In some programming languages, it is common to prefix identifiers with underscores
{#syntax#}__like_this{#endsyntax#} to indicate some vague notion of privacy or danger
associated with usage of the identifier.</p>
<p>In Zig, there are no private fields, and it is better not to pretend
otherwise. Fields should be named carefully to communicate their
semantics and documentation should indicate how to use fields without
violating data invariants. Underscore prefixes serve only to make code
authors feel better about writing clumsy, overly prescriptive, poorly
documented code.</p>
{#header_close#}
{#header_open|Whitespace#}
<ul>
<li>