Yamyam: 1版をインポートしました

2018-06-28T17:52:37Z

1版をインポートしました

wiki>Ideasman42: Better code style docs elsewhere.

2016-02-06T07:43:55Z

Better code style docs elsewhere.

新規ページ

== Function name conventions ==

A function should be named with subject first, then the verb:
<prefix>_<what it is>_<what it does>

Prefix is the "module", and can be upper or lower case, if it's
upper case, means exported outside its own module (the API), with lower
case it's a local module only, for example:

<source lang="c">
void WM_screen_activate()

void wm_check()
</source>

If a function is only used inside a C file, it should be made static. It then doesn't have to follow the prefix rule, depending on clarity...

<source lang="c">
static void wm_window_close()
static int query_qual()
</source>

== Struct name conventions ==

The same prefix and order rule can apply to exported struct names, but with the openGL
convention, to have them clearly distinguished from function names. for example:

<source lang="c">
struct wmWindowManager {
};

struct uiBlock {
};
</source>

Structs on global (kernel) level can get a 'b' prefix:

<source lang="c">
struct bContext {
};
</source>

But that's not enforced really... (see DNA structs)

== #define name conventions ==

Defines are always fully capitalized, and have prefix to show origin:

WM_NOTE_WINDOW_REDRAW

to prevent prefixes to become confusingly long, special ones are fine too, like for keymap defines:

KM_ALT
KM_PRESS

== Operator definitions ==

For Operator definitions it's important to find out where they are located. Here an extra OT is added in the name, to indicate "Operator Type"

WM_OT_window_duplicate
ED_SCR_OT_cursor_type
ED_UI_OT_button_activate

Since these are names saved in operator stacks (macros) it's important to make them nice and future proof.

== Variables ==

* Variable names are lower case only, also in structs
* Names are minimal 2 characters, unless it's a counter in a loop.

[[Category:Script]]

← 古い版	2018年6月28日 (木) 17:52時点における版
(相違点なし)

Dev:2.5/Source/Architecture/NamingConvention - 版の履歴

Yamyam: 1版 をインポートしました

wiki>Ideasman42: Better code style docs elsewhere.

Yamyam: 1版をインポートしました