|
| HOME > ソフテックだより > 第139号(2011年6月1日発行) 技術レポート「効果的なソースコードのコメントについて」 |
|
|
ソフテックだより 第139号(2011年6月1日発行) 技術レポート 「効果的なソースコードのコメントについて」 |
| // 「ソースコードの説明」例 // ((a × 8) ÷ 2) × 16をシフト演算(高速化のため)で計算 work = (( a << 3 ) >> 1) << 4; |
| // 「ソースコードの目印」例 // TBD 未完成!リリース前に必ず修正すること! return NULL; |
|
|||
|
図3. 「ソースコードの要約コメント」と「ソースコードの繰り返しコメント」例 |
| /* ソースコードの意図を説明したコメント例 */ unsigned char g_byBuf[10]; void FuncA(unsigned char *pbySrc) { // 処理速度向上のため、代入でコピーする g_byBuf[0] = pbySrc[0]; g_byBuf[1] = pbySrc[1]; g_byBuf[2] = pbySrc[2]; g_byBuf[3] = pbySrc[3]; g_byBuf[4] = pbySrc[4]; g_byBuf[5] = pbySrc[5]; g_byBuf[6] = pbySrc[6]; g_byBuf[7] = pbySrc[7]; g_byBuf[8] = pbySrc[8]; g_byBuf[9] = pbySrc[9]; } |
|
|||
|
図5. 「理由に重点をおいたコメント」と「方法に重点をおいたコメント」例 |
|
|||
|
図6. コメント位置の例 |
(M.A.)
[参考文献]
| 日経BPソフトプレス 『CODE COMPLETE第2版 下巻』 |
![]() TEL:03-5368-1641 |
Copyright(C) 1997-2012 SOFTECH CO.,LTD. |