authorgravatar for mail@isaacfreund.comIsaac Freund <mail@isaacfreund.com> 2020-05-02 23:28:44+02:00
committergravatar for mail@isaacfreund.comIsaac Freund <mail@isaacfreund.com> 2020-05-02 23:28:44+02:00
log3a397795be1c0219a3a0d96082ee7d4eeddbfa7a
treeca153cf8828778b4ec8782b7d2ea3fa83af6c0b1
parent03a7124543a52f7904090516e572b71b893c7ba2
signaturelock-open Commit is signed but in an unrecognized format.

Apply naming conventions of structs to files


1 files changed, 8 insertions(+), 0 deletions(-)

doc/langref.html.in+8
......@@ -9990,6 +9990,13 @@ coding style.
99909990 conventions.
99919991 </p>
99929992 <p>
9993 File names fall into two categories: types and namespaces. If the file
9994 (implicity a struct) has top level fields, it should be named like any
9995 other struct with fields using {#syntax#}TitleCase{#endsyntax#}. Otherwise,
9996 it should use {#syntax#}snake_case{#endsyntax#}. Directory names should be
9997 {#syntax#}snake_case{#endsyntax#}.
9998 </p>
9999 <p>
999310000 These are general rules of thumb; if it makes sense to do something different,
999410001 do what makes sense. For example, if there is an established convention such as
999510002 {#syntax#}ENOENT{#endsyntax#}, follow the established convention.
......@@ -9998,6 +10005,7 @@ coding style.
999810005 {#header_open|Examples#}
999910006 {#code_begin|syntax#}
1000010007const namespace_name = @import("dir_name/file_name.zig");
10008const TypeName = @import("dir_name/TypeName.zig");
1000110009var global_var: i32 = undefined;
1000210010const const_name = 42;
1000310011const primitive_type_alias = f32;