コードレビュー(DigitalWrite)

[hiyanaka]

背景

コードの品質を上げる必要性がある。

目的

レビューを行いコードの品質を上げるため。

対応内容

コードレビューを行う

https://github.com/HAL-RO-Developer/iot_platform/tree/master/device/source/end_func/DWrite

[makki0205]

■２３行目
文字列作成に規則性が見られる。
関数化し、同一処理が散見されるのを防ごう。
これを行うことで、余計な変数宣言も回避出来る。

iot_platform/device/source/end_func/DWrite/blinkDWrite/blinkDWrite.ino

Line 23 in b44ae3d

String rtn = "{\"result\":\"NG\"}";

■ローカル変数・グローバル変数
①ローカル変数
　必ず初期値を入れること（戻り値の場合はエラーＩＤを格納）。
　これは後々アルゴリズム変更時に発生し得る不具合を回避する為。

②グローバル変数
setup関数での初期化に加え、１２行目の宣言時でも初期値を入れるべき。

■コメント
全てのコメントが単語で、理解し辛い。
万人が理解出来る、端的な文章で記述すること。

■意味のある数値
他の箇所でも使用する可能性のある「意味のある数値・文字列」は、全てdefine化すること。

iot_platform/device/source/end_func/DWrite/blinkDWrite/blinkDWrite.ino

Line 18 in b44ae3d

Serial.begin( 115200 );

iot_platform/device/source/end_func/DWrite/blinkDWrite/blinkDWrite.ino

Line 28 in b44ae3d

StaticJsonBuffer<200> jsonBuffer;

iot_platform/device/source/end_func/DWrite/blinkDWrite/blinkDWrite.ino

Line 39 in 41f6d01

if( elapsedTime > 5000 ){

iot_platform/device/source/end_func/DWrite/blinkDWrite/blinkDWrite.ino

Line 39 in 41f6d01

if( elapsedTime > 5000 ){

■digiWrite関数
関数は”誰から呼ばれるか分からない”。
故に引数チェックは必ず入れ、エラー時はユーザー通知をするべき。
落ちる可能性は極力排除すること。

iot_platform/device/source/end_func/DWrite/blinkDWrite/blinkDWrite.ino

Line 66 in 41f6d01

String digiWrite( int pin, int mode, int val ){

■Serial.printlnを呼び出している箇所
引数の設定方法に統一性が無い。
直文字の場合もあれば、変数を入れてる場合もある。
パターン文字列は全てdefine化し、変更に強くすると共に、統一性の向上を図ること。