関数の頭につける「brief」ってなに?パンツなの?


こんにちは。こんばんは。よつもです。


ソースコード書いていたら、
関数の情報をこれを参考に書けー!
と上司に言われたので、

見てみたらこんなの ↓

//!
//! @brief 〇〇
//! @param 〇〇
//! @param 〇〇
//! @return 〇〇
//!
// ~~これより下は関数~~

なんとなく言いたいことは分かった。
こんな感じの意味でしょ??

//!
//! @brief 〇〇←ナニコレ
//! @param 第1引数の詳細
//! @param 第2引数の詳細
//! @return 返り値
//!


調べたら「brief」以外は
そんな感じの意味だった。


でも「brief 」って何??
読み方はそのまま「ぶりーふ」でいいの??


今日の履いているブリーフについて書くの??


いやいや。


で、結局これは関数の概要について書くところらしい。


「brief 」の意味は「簡潔な」とか「概要」って意味があるらしく、
メタルギアによく出てくる「ブリーフィング」ってやつも
簡潔な状況説明をするって意味でつかわれているんだってさ。


とりあえず関数の情報はつけなきゃだめよって話でした。