注釈マーキングの原則
1.複数の注釈フォーム
- 非常に多くの注釈フォームがあるため、1つの目的はさまざまな装飾効果を実現することです。
1.1強調しない注記
/* 单行注释常用于注释程序主题代码*/
1.2強調した注記
/* --> 注意：需要处理错误信息 <--*/
- 1行コメントをどのように装飾するかは、プログラマーの個人的な好みによって異なります。どんな特殊文字が使われていても。目を引くものであり、注釈の開始点と終了点を明確に示すことができる限り。
1.3強調せずに複数行のコメント
/*
*可以通过此种形式编写包含多行语句的注释
*没有需要特别强调的内容，但需要用较长的句子
进行更准确的说明时，使用此类注释。
*/
- コメントの内容を区別するために、中央に特殊文字を挿入することもできます
/*
- 校验模块的输入值
- --------------------------------------
- input ： 总计，不能使用浮点数
- input2 ：合计，用于比较平均值
*/
1.4強調した複数行のコメント
- 複数行コメントを作成するときに、含まれているコード部分またはコメントコンテンツの順序を強調する必要がある場合は、次のフォームを使用します。
/*************************************/
/*！！！！！警告（warning）！！！！！*/
/*************************************/
/* 所有数据都必须经过精确校验，并通过数十次测试以确保万无一失。*/
/************************************/
- どんな書き方をしても、コメントの主な目的はプログラマーの注目を集めることです。眼球を最大限に修正できれば、見た目は気にしないでください。
2.1行コメントとコメントボックスを区別します
2.1注釈フォームの分類
- 1行コメント
- 単一行以外のコメント（複数行コメント）
2.2使用の原則
- ジュニアプログラマーは、プログラムの開始時に1行コメントを使用します。このような1行コメントは、プログラムまたは関数をどのように詳細に指定できますか？
- 1行のコメントは、補足のプログラム本体ステートメントに適用できますが、十分なプログラムまたは機能情報を提供することはできません。したがって、プログラムや機能を説明する必要がある場合は、複数行コメントを使用する必要があります。
2.3複数行コメントの例
- 通常、複数行のコメントは「コメントボックス」または「ブロックコメント」とも呼ばれます。
- コメントボックスは、プログラムの参照に相当します。これは、大規模なプロジェクトで特に重要です。実際、プログラマーは、プログラムコード自体よりも、コメントボックスによって提供される情報からより多くの手がかりを得ることができます。
/* ========================== */
/* 原程序名：func.c */
/* 可执行程序名：func.exe */
/* */
/* 目标： 调用各文件操作函数 */
/* */
/* 编写者：豆豆哥 */
/*最初编写日期：2020年12月07日*/
/* 第一次修改日期：。。。。。*/
...................
/*第二次修改日期：。。。。。*/
/* 改进函数和函数调用 */
/* ===========================*/
#include<stdio.h>
.....省略......
3.「変数辞書を書くための特別なコメント」を追加します
3.1一体何を話しているのですか？
- 1行に1つの変数のみを宣言し、変数の横に詳細なコメントを追加します。このメソッドは、「変数辞書書き込み特殊コメント」または略して「辞書コメント」と呼ぶことができます。次のように：
/*
文件名：calcarea.dic
文件用途： calcarea.prj项目所用的main.c模块的字典变量 */
/* 1. main.c中的变量*/
int area;/* 面积：xxx的面积*/
int wide;/* 宽度 xxx的宽度*/
int height;/* 高度 xxx的高度*/
/* 2. calc.c中的变量*/
int block_sum;/* 区划面积和：xxx的面积*/
int total;/* 区域面积和：xxx的面积*/
static int area;/* 保存各单位土地的面积*/
- 辞書のコメントは、プログラムの詳細において重要な位置を占めています。書くことを忘れないでください。
4.プログラムに擬似コードを挿入します
4.1擬似コード？
- 擬似コードは、プログラムのロジックを表現するために使用されます。擬似コードは日常の言語で表現できるため、プログラミング言語に慣れていない人でもプログラムのロジックを簡単に理解できます。
4.2擬似コードに注釈を付ける
/* [该程序的伪代码] */
/* 预定义表示输入值的整数变量num1、num2
表示最大值和最小值的max、min */
/* */
/* 将接受的两个主属性输入值依次
保存到num1和num2 */
/* 如果num1大于num2 */
/* 则num1时最大值，将其保存到max */
/* num2是最小值，将其保存到min */
/* 否则 */
/* 呼唤保存的最大值和最小值 */
/* */
/* 将max输出为最大值，min输出为最小值 */
/* [伪代码结束]*/
#include <iostream>
using namespace std;
int main()
{
int num1,num2,max,min;
if (num1 > num2) {
max = num2;
min = num1;
}
else{
max = num2;
min = num1;
}
cout << "最大值：" << max << endl;
cout << "最小值：" << min << endl;
...略
return 0；
}
- 単純なプログラムでは効果がない場合があります。10行または数百行のプログラムの場合、そのロジックは約10行の擬似コードでしか表現できません。
- したがって、擬似コードはプログラムをすばやく把握するのに非常に効果的です。
5.注釈を使用してプログラムの目標に注釈を付ける
5.1それはどういう意味ですか？
- 擬似コードは一目で論理を明確にすることができますが、非常に多くの擬似コードがあります。プログラムが一目で何をしているのかわかりません。現時点では、の役割を説明するためにコメントの行が必要です。プログラム。
5.2要件
メモを書くための6ホーの原則に準拠する
1.何时(when) 编写日期：2020年11月1日
2.何地（where） 场所 ：xxx小组
3.何人（who） 编写者 ：豆豆哥
4.何事（what） 代码性质：c语言代码 约100行
5.为何（why） 编写理由：最大值、最小值教学
6.如何（how） 编写环境：控制台
- 上記のコメントは少し鈍いです、あなたはそれをプログラムのターゲットとして置くために1つの文を使うこともできます
- プログラムを構成する関数とクラスの前に、十分なコメントテキストと擬似コードを追加する必要があります。
6.ヘッダーコメントをプログラムの先頭に追加する必要があります
6.1メリット
- ヘッダーコメントは、プログラムの実際の部分にあり、プログラムのタイトル、作成者、目標などを示すために使用されます。
- ヘッドコメントは名刺に相当します。ヘッドコメントを通じて、まずプログラム全体を理解し、次にメインコメントに基づいてプログラムをより深く理解することができます。
6.2優れたヘッダー注釈の記述の例
/* 文件名：func.c */
/* 出处：www.xxxxx.cn */
/* 编写者： 软件开发3组 豆豆哥 */
/* 目标：读取用户登录信息 */
/* 提供客户服务中心所需的数据 */
/* 使用方式：依靠操作系统中的任务计划程序
/*sched.exe */
/* 每天自动运行一次 */
/* 编译该程序得到可执行文件func。exe*/
/* 必须与sched.exe位于同一目录*/
/* 所需文件：读取模式(r)下的userlog.dat*/
/*的内容并获取统计数据，之后再写模式(w)*/
/*下的useracnt.dat中记录这些统计数据。*/
.....略....
/* 限制条件：1.userlog.dat必须事先存在*/
/* 如果该文件不存在 */
/* 则需检查logcount.exe文件能否正常运行*/
/* 2.该程序必须在凌晨2点之后运行 */
/* 需要修改任务计划sched.c时 */
/* 请注意不要修改该时间 */
/* 异常处理：出现各种错误时，应在 */
/*errlog.dat中写入错误日志文件，并立即*/
/*终止该程序 */
/* 历史记录：1.2020年12月1日 开始编写*/
/* 2. 2020年12月6日 修改程序*/
- 上記のコメントには8つの項目が含まれていますが、これらも必須です
- ファイル名
- 作家
- 目的
- 使い方
- 必要なファイル
- 制限要因
- 例外処理
- 歴史記録
- ヘッダーコメントを書くのは面倒だと感じる人もいます。怠惰にならず、プログラムを変更する可能性のある他の人の観点から問題を考慮し、可能な限り詳細に説明してください。
7.等しい演算子の横にコメントを追加します
初心者プログラマーにとって、==と=はばかげて不明瞭で、しばしば混乱します
- 以下を見てください。ステートメントの比較も間違っている場合は、代入エラーをカウントします
while (count == 1; count++; count <= 100) {
... }
if (isThis = True) {
... }
- エラーが報告されたときに、自分のコードの意味を簡単に確認して比較できるように、その横にコメントを追加することをお勧めします。
7.1追加したくない場合はどうすればよいですか？
- 追加する必要はありませんが、少し考えが必要です。比較するときは、等号の左側に定数を置きます。これにより、コードを確認するときに、ここで比較演算子が使用されていることがすぐに推測できます。
if (1 = isThis) {
... }
8.中括弧の終わりにコメントを追加します
入れ子になった中括弧が多いと、どの関数がどれなのか一目でわかりませんが、めまいがします。
- コードブロックの実際の部分にコメントを追加する必要はないと思います。必要ありません。
- 中括弧が閉じている場所にコメントを追加することをお勧めします。規則に従って、endで始まるコメントは、end if、end main、end while、end classMyclassである必要があります。
- もちろん、このステートメントを使用して、閉じ中括弧の意味を説明することもできます。
int main () {
...
if () {
...
if () {
...
} //end if
}//end if
}//end main
9.関数内に関数を詳細に説明するコメントを追加します
- 十分なドキュメントがあり、一般的に広く使用されている関数の場合、コメントを追加する必要はありません。
- ただし、プロジェクトでのみ使用する場合でも、iyig内で使用する関数で使用する場合でも、詳細なコメントを残す必要があります。
- 次の内容を厳密に記録するには、特別な注意を払う必要があります。
- 関数の目的
- 許容されるデータ型と各パラメーターの意味
- 戻り値を適用する場所
10.まとめ
- 以下の一般的なガイドラインに従ってください。コメントを追加する場所と追加しない場所を指定するガイドラインがない場合でも、コメントを追加する習慣をある程度維持することができます。
- コード自体が問題を説明するのに十分である場合、コメントを追加する必要はありません。
- コード自体が問題を説明するのに十分でない場合は、可能な限り詳細なコメントを追加してください。