AUTOSAR CountdownAdvent Calendar 2022

Qiita(34) に投稿するC, C++(79)の書式例 coding(21)

Last updated at 2024-10-26Posted at 2018-04-07

0 目的(purpose)

Qiitaに投稿する自分のまたは引用したソースコードの書式(style)に一貫性を持たせることにより、読みやすく、誤解が生じにくくすることを目的とする。

成果(outcome)

国際規格、コーディング標準などのコード断片を引用しており、
これらの文書との整合性をどのように取ると良いかの考えが整理できる。

背景(background)

QiitaにC, C++のプログラムを投稿していて、
自分でも分かりにくいことが多々ある。

予定(schedule)

Styleの代表例を作ってみる。

自分が全部描く場合は、なるべく代表例に沿い、
他のプログラムを引用して追記する場合には、
追記する部分を代表例に従うことにする。

現在あげているソースは順次、この書式に近い形式に変更して行く。
今後あげるソースで、この書式では不十分な場合は、この書式を変更する。

1　前段(introduction)

1.1 著作権(copyrightt)または著者(author)

個人、または団体名を記載する。
自分が試験用に追記した部分は、当面///で始まるコメント行とする。
ただし、引用したソースが///で始まるコメント行を利用している場合には、別の方法を検討する。

1.2情報源(information source)

本またはネットに公開されているソースは、書名またはURLを記載する。ページ数のある冊子の場合はなるべくページ数を記載する。

1.3 目的(purpose)と成果(outcome)

何のためのプログラムでどういう成果があるかを記載する。
国際規格、コーディング規則の場合は、章節名、実行結果の記載で代替することがある。
国際規格、コーディング規則は、立場によって見え方が違い、目的と成果もそれぞれである。目的と成果を議論したい場合以外は、記載しない。

1.4 系(system)

編纂器(compiler)

コンパイラの名称と版を記載する。

環境(environment)

C言語の場合は、hosted, freestaningの区別と、実行結果を記録した環境名を記載する。

台本(script)

複数の編纂器を利用する台本などを記載する。
実行結果にURLを記載することで代替することがある。

整形は台本a.shを使う。

第二部算譜(code)

2.1 ヘッダファイル

必要最小限のヘッダをincludeする。
試験作業の効率上、最終的には不要になるヘッダファイルが残っていることがある。
該当するCソースファイルに固有なヘッダファイルを作ることがある。
また、国際規格、コーディング標準に共通のヘッダファイルを作ることがある。

2.2 定数・変数・マクロ宣言・ファイル

必要最小限の定数、変数、マクロ宣言とする。
定数の値、文字変数の値、ファイルの値などは、そのソースコードファイルおよび記述を利用することがある。
例えば、ファイル読み込みは、指定がなければ、ソースコードファイルを読み込む。

2.3 出力(output)

必要最小限の出力とする。
条件分岐の結果がわかるような出力を追記することがある。（printf debug, cout debug)
暴走するのを防いだり、処理時間を確認するための出力を記載することがある。
出力が必要でない処理の場合は、表題・ファイル名等を出力することがある。

字下げ(indentation)

字下げは2文字を原則とする。
Web上で見る場合に、折り返しがなるべく少なくするためである。

a.sh

#!/bin/bash
astyle -s2 -c -N < $1.cpp > $1s2.cpp
cat $1s2.cpp

命名規則(naming convention)

定数名(constant name)

定数名は大文字だけを原則とする。
英語で意味のある名前とする。場合によっては日本語のローマ字表記相当の場合もある。

変数名(variable name)

変数名は小文字だけを原則とする。
ループ変数のi,j,k、簡単な計算の変数、a,b,c,x,y,z、文字列のs,文字のcなどの１文字変数を使うことがある。

関数名(function name)

関数名は小文字だけを原則とする。
簡単な処理をする関数は、f,g,h等の１文字関数を使うことがある。

startup 関数

C言語のhosted環境の場合は、

int main(int argc, char * argv[]);
int main(void)
void main(void)

といずれかとする。

C言語のfreestanding環境の場合は

void startup(void);
void startup(int argc);
void startup(char * argv[]);
int startup(void);

など、その時々の必要に応じて記述する。
hosted環境と同じプログラムを実行する場合の名前は
mainのままとすることがある。
この場合には、freestanding環境のstartup関数の別名としてmainを定義するか、リンクスクリプトでmainをstartupに変換するかはその時々とする。
startup関数に引数、戻り値がある場合には、startup関数手を入れる場合がある。
単純な例として、引数の数を引数とし、引数の数の値を戻り値として、実行中に値に変更が加わっていないかを確かめるのに用いる。

出力機構(output mechanism)

C言語のfreestanding環境においてC言語のhosted環境と同じソースをコンパイルする場合は、ヘッダファイルのマクロにおいて、printf関数をfreestanding環境における出力関数に置き直すことがある。

C++のhosted環境においてはcoutを
using namespace std;
を宣言して利用する。

第三部　結果(result)

3.1 誤(error)、警告(warning)

オプションをつけない場合を記録する。
C89(ISO/IEC9899:1990), C1999, C2011対応の場合、
C++(ISO/IEC 14882:1998,C++2003, C++2011, C++2014, C++2017対応の場合には、
それぞれの版のオプションをつけることがある。

3.2 実行結果(execution result)

コンパイルエラーで実行できない場合以外は実行結果をつける。
暴走したり、画面に何も表示せずに、数分立っても終わらない場合はその旨を記載する。

例(example)

accfree.c

// ISO/IEC JTC 1/SC 22/WG 14 N 1624 Date: 2012-06-26 ISO/IEC TS 17961, p.7
/// lines are added by Dr. Kiyoshi Ogawa, 2018
/// Compiled on 
///  Clang(LLVM) clang version 6.0.0 (tags/RELEASE_600/final) 
///  GCC(GNU) gcc-7 (Homebrew GCC 7.3.0_1) 7.3.0
/// hosted Environment macOS 10.13.3 or 10.12.9
// EXAMPLE 1 In this noncompliant example, a diagnostic is required because head->next is accessed after head has been freed.

#include <stdio.h>/// for printf
#include <stdlib.h>/// for EXIT_SUCCESS

struct List { struct List *next; /* ... */ };
void free_list(struct List *head) {
  for (; head != NULL; head = head->next) { // diagnostic required
    printf("%ld %ld \n",(long)head, (long)head->next);
    free(head);
  }
}
int main(int argc, char** argv){///
  struct List *lista;///
  size_t sz = sizeof(struct List);///
  lista = malloc(sz);///
  lista->next = NULL;///
  printf("%ld \n",(long)lista);///
  free_list(lista);///
  return EXIT_SUCCESS;///
}///

shell

$ ./gcc7ts.sh accfree
$ clang accfree.c
140206166508352 
140206166508352 0 

$ gcc-7 accfree.c
140691146539008 
140691146539008 0

参考資料(reference)

コンパイル用shell script C版(clangとgcc)とC++版(clang++とg++)
https://qiita.com/kaizen_nagoya/items/74220c0577a512c2d7da
プログラマが知っていると良い「公序良俗」
https://qiita.com/kaizen_nagoya/items/9fe7c0dfac2fbd77a945
Coding Rules(0) C Secure , MISRA and so on
https://qiita.com/kaizen_nagoya/items/400725644a8a0e90fbb0

OSEK OS設計の基礎　OSEK(100)
https://qiita.com/kaizen_nagoya/items/7528a22a14242d2d58a3

Error一覧(C/C++, python, bash...) Error(0)
https://qiita.com/kaizen_nagoya/items/48b6cbc8d68eae2c42b8

なぜdockerで機械学習するか書籍・ソース一覧作成中 (目標100)
https://qiita.com/kaizen_nagoya/items/ddd12477544bf5ba85e2

言語処理100本ノックをdockerで。python覚えるのに最適。:10+12
https://qiita.com/kaizen_nagoya/items/7e7eb7c543e0c18438c4

プログラムちょい替え（0）一覧:4件
https://qiita.com/kaizen_nagoya/items/296d87ef4bfd516bc394

TOPPERSまとめ　#名古屋のIoTは名古屋のOSで
https://qiita.com/kaizen_nagoya/items/9026c049cb0309b9d451

docker(0) 資料集
https://qiita.com/kaizen_nagoya/items/45699eefd62677f69c1d

Qiita-dockerお宝鑑定団
https://qiita.com/kaizen_nagoya/items/509e125263559b5aed5b

The C++ Standard Library: clang++とg++でコンパイルしてみた(まとめ):14件
https://qiita.com/kaizen_nagoya/items/9bdfaa392443d13e5759

C++17 - The Complete Guide clang++とg++でコンパイルしてみた(まとめ):4件
https://qiita.com/kaizen_nagoya/items/c000f307e642990781e1

C++N3242, 2011, ISO/IEC 14882, C++ standard(1) Example code compile list
https://qiita.com/kaizen_nagoya/items/685b5c1a2c17c1bf1318

C++N4606 Working Draft 2016, ISO/IEC 14882, C++ standard(1) Example code compile list
https://qiita.com/kaizen_nagoya/items/df5d62c35bd6ed1c3d43/

C++N4741, 2018 Standard Working Draft on ISO/IEC 14882 sample code compile list
https://qiita.com/kaizen_nagoya/items/3294c014044550896010

C++N4910:2022 Standard Working Draft on ISO/IEC 14882(0) sample code compile list
https://qiita.com/kaizen_nagoya/items/fc957ddddd402004bb91

Autosar Guidelines C++14 example code compile list(1-169)
https://qiita.com/kaizen_nagoya/items/8ccbf6675c3494d57a76

<この項は書きかけです。順次追記します。>
This article is not completed. I will add some words and/or centences in order.

自己記事一覧

Qiitaで逆リンクを表示しなくなったような気がする。時々、スマフォで表示するとあらわっることがあり、完全に削除したのではなさそう。

４月以降、せっせとリンクリストを作り、統計を取って確率を説明しようとしている。
2025年２月末を目標にしている。

物理記事　上位100
https://qiita.com/kaizen_nagoya/items/66e90fe31fbe3facc6ff

量子(0) 計算機, 量子力学
https://qiita.com/kaizen_nagoya/items/1cd954cb0eed92879fd4

数学関連記事１００
https://qiita.com/kaizen_nagoya/items/d8dadb49a6397e854c6d

統計(0)一覧
https://qiita.com/kaizen_nagoya/items/80d3b221807e53e88aba

図(0) state, sequence and timing. UML and お絵描き
https://qiita.com/kaizen_nagoya/items/60440a882146aeee9e8f

品質一覧
https://qiita.com/kaizen_nagoya/items/2b99b8e9db6d94b2e971

言語・文学記事　１００
https://qiita.com/kaizen_nagoya/items/42d58d5ef7fb53c407d6

医工連携関連記事一覧
https://qiita.com/kaizen_nagoya/items/6ab51c12ba51bc260a82

自動車　記事　１００
https://qiita.com/kaizen_nagoya/items/f7f0b9ab36569ad409c5

通信記事１００
https://qiita.com/kaizen_nagoya/items/1d67de5e1cd207b05ef7

日本語（０）一欄
https://qiita.com/kaizen_nagoya/items/7498dcfa3a9ba7fd1e68

英語(0) 一覧
https://qiita.com/kaizen_nagoya/items/680e3f5cbf9430486c7d

転職(0)一覧
https://qiita.com/kaizen_nagoya/items/f77520d378d33451d6fe

仮説（0）一覧（目標100現在40）
https://qiita.com/kaizen_nagoya/items/f000506fe1837b3590df

音楽　一覧(0)
https://qiita.com/kaizen_nagoya/items/b6e5f42bbfe3bbe40f5d

「@kazuo_reve 新人の方によく展開している有益な情報」確認一覧
https://qiita.com/kaizen_nagoya/items/b9380888d1e5a042646b

Qiita(0)Qiita関連記事一覧（自分）
https://qiita.com/kaizen_nagoya/items/58db5fbf036b28e9dfa6

鉄道（０）鉄道のシステム考察はてっちゃんがてつだってくれる
https://qiita.com/kaizen_nagoya/items/faa4ea03d91d901a618a

安全（0）安全工学シンポジウムに向けて: 21
https://qiita.com/kaizen_nagoya/items/c5d78f3def8195cb2409

一覧の一覧( The directory of directories of mine.) Qiita(100)
https://qiita.com/kaizen_nagoya/items/7eb0e006543886138f39

Ethernet 記事一覧　Ethernet(0)
https://qiita.com/kaizen_nagoya/items/88d35e99f74aefc98794

Wireshark 一覧 wireshark(0)、Ethernet(48)
https://qiita.com/kaizen_nagoya/items/fbed841f61875c4731d0

線網（Wi-Fi）空中線(antenna)(0) 記事一覧(118/300目標)
https://qiita.com/kaizen_nagoya/items/5e5464ac2b24bd4cd001

C++ Support(0)　
https://qiita.com/kaizen_nagoya/items/8720d26f762369a80514

Coding(0) Rules, C, Secure, MISRA and so on
https://qiita.com/kaizen_nagoya/items/400725644a8a0e90fbb0

coding (101) 一覧を作成し始めた。omake:最近のQiitaで表示しない5つの事象
https://qiita.com/kaizen_nagoya/items/20667f09f19598aedb68

プログラマによる、プログラマのための、統計(0)と確率のプログラミングとその後
https://qiita.com/kaizen_nagoya/items/6e9897eb641268766909

なぜdockerで機械学習するか書籍・ソース一覧作成中 (目標100)
https://qiita.com/kaizen_nagoya/items/ddd12477544bf5ba85e2

言語処理100本ノックをdockerで。python覚えるのに最適。:10+12
https://qiita.com/kaizen_nagoya/items/7e7eb7c543e0c18438c4

Python(0)記事をまとめたい。
https://qiita.com/kaizen_nagoya/items/088c57d70ab6904ebb53

官公庁・学校・公的団体（NPOを含む）システムの課題、官（０）
https://qiita.com/kaizen_nagoya/items/04ee6eaf7ec13d3af4c3

「はじめての」シリーズ　ベクタージャパン　
https://qiita.com/kaizen_nagoya/items/2e41634f6e21a3cf74eb

AUTOSAR(0)Qiita記事一覧, OSEK(75)
https://qiita.com/kaizen_nagoya/items/89c07961b59a8754c869

プログラマが知っていると良い「公序良俗」
https://qiita.com/kaizen_nagoya/items/9fe7c0dfac2fbd77a945

LaTeX(0) 一覧　
https://qiita.com/kaizen_nagoya/items/e3f7dafacab58c499792

自動制御、制御工学一覧（０）
https://qiita.com/kaizen_nagoya/items/7767a4e19a6ae1479e6b

Rust(0) 一覧　
https://qiita.com/kaizen_nagoya/items/5e8bb080ba6ca0281927

100以上いいねをいただいた記事16選
https://qiita.com/kaizen_nagoya/items/f8d958d9084ffbd15d2a

小川清最終講義、最終講義（再）計画, Ethernet(100) 英語(100) 安全(100)
https://qiita.com/kaizen_nagoya/items/e2df642e3951e35e6a53

＜この記事は個人の過去の経験に基づく個人の感想です。現在所属する組織、業務とは関係がありません。＞
This article is an individual impression based on my individual experience. It has nothing to do with the organization or business to which I currently belong.

文書履歴(document history)

ver 0.10 初稿 20180407
ver 0.11 C++追記 20180408
ver 0.20 整形台本追記 20180524
＜この記事は個人の過去の経験に基づく個人の感想です。現在所属する組織、業務とは関係がありません。＞

最後までおよみいただきありがとうございました。

いいね　💚、フォローをお願いします。

Thank you very much for reading to the last sentence.

Please press the like icon 💚　and follow me for your happy life.

You get articles that match your needs
You can efficiently read back useful information
You can use dark theme

What you can do with signing up

Qiita(34) に投稿するC, C++(79)の書式例 coding(21)

0 目的(purpose)

成果(outcome)

背景(background)

予定(schedule)

1　前段(introduction)

1.1 著作権(copyrightt)または著者(author)

1.2情報源(information source)

1.3 目的(purpose)と成果(outcome)

1.4 系(system)

編纂器(compiler)

環境(environment)

台本(script)

第二部算譜(code)

2.1 ヘッダファイル

2.2 定数・変数・マクロ宣言・ファイル

2.3 出力(output)

字下げ(indentation)

命名規則(naming convention)

定数名(constant name)

変数名(variable name)

関数名(function name)

startup 関数

出力機構(output mechanism)

第三部　結果(result)

3.1 誤(error)、警告(warning)

3.2 実行結果(execution result)

例(example)

参考資料(reference)

関連資料

Engineering Festa 2024前に必読記事一覧

自己記事一覧

文書履歴(document history)

最後までおよみいただきありがとうございました。

Thank you very much for reading to the last sentence.

Qiita(34) に投稿するC, C++(79)の書式例 coding(21)

0 目的(purpose)

成果(outcome)

背景(background)

予定(schedule)

1 前段(introduction)

1.1 著作権(copyrightt)または著者(author)

1.2情報源(information source)

1.3 目的(purpose)と成果(outcome)

1.4 系(system)

編纂器(compiler)

環境(environment)

台本(script)

第二部 算譜(code)

2.1 ヘッダファイル

2.2 定数・変数・マクロ宣言・ファイル

2.3 出力(output)

字下げ(indentation)

命名規則(naming convention)

定数名(constant name)

変数名(variable name)

関数名(function name)

startup 関数

出力機構(output mechanism)

第三部 結果(result)

3.1 誤(error)、警告(warning)

3.2 実行結果(execution result)

例(example)

参考資料(reference)

関連資料

Engineering Festa 2024前に必読記事一覧

自己記事一覧

文書履歴(document history)

最後までおよみいただきありがとうございました。

Thank you very much for reading to the last sentence.

1　前段(introduction)

第二部算譜(code)

第三部　結果(result)