Nishida-Lab / rosbook_pkgs

「実用ロボット開発のためのROSプログラミング」サンプルコード

http://amzn.asia/d/ct0zwBh

45 stars 18 forks source link

サンプルコードに関する残件 #31

Open MoriKen254 opened 6 years ago

MoriKen254 commented 6 years ago

2 の議論が発散してきて、残件が見えにくくなってきました。ここで一旦論点をまとめて、 #2 はお蔵入りとします。

本文の兼ね合いもあり手が出しにくいところもあり、残件になっています。着手自体はいつでも可能。

性能の問題

C++ のメソッドでオブジェクトをコピー渡ししているので処理が遅い。
- [ ] const & で参照渡しすべき。

スタイルの問題

ROS コーディングスタイルに準拠していない。
- 準拠するよう編集する。
- C++
  - http://wiki.ros.org/CppStyleGuide
  - [ ] インデントにスペースとタブが混在
  - [ ] 中括弧を置く位置の統一
  - [ ] for ループのスタイルの非統一
  - [ ] C++標準ライブラリに存在する関数の再発明
- Python
  - http://wiki.ros.org/PyStyleGuide
オートフォーマッタは引数の多いメソッドに対応できない。手動編集がベター。
- 詳細は #2 を参照。
命名規則
- [ ] 頻出するオブジェクトの命名則の統一（ros::NodeHandle を n にするか nh にするか、など）
- 説明的な命名による可読性の向上（本文への影響が大で難しそう）

本文とソースコードの乖離の問題

出版後に読者からの問い合わせやプルリク等を受け、ソースコードが編集されることはありえる。
- [ ] 「公開しているサンプルコードは品質改善のために予告なく修正される可能性がある。」とかの免責事項も必要？

C++ と Pythonを両方用意しようか？

そもそもつい最近まで本文中のコードすら納品されておらずてんてこ舞いでそれどころではなかったよ！笑
[ ] 以降、対となる言語のコードを追加する分には、しれっと入れてもいいと思います。本文に影響はしませんし、読者が気づけばラッキーと思ってくれるでしょう。