Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
8 tasks
MoriKen254 opened this issue Jul 24, 2018 · 0 comments
Open
8 tasks

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

MoriKen254 opened this issue Jul 24, 2018 · 0 comments

Comments

@MoriKen254
Copy link
Member

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

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

性能の問題

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

スタイルの問題

  • ROS コーディングスタイルに準拠していない。
  • オートフォーマッタは引数の多いメソッドに対応できない。手動編集がベター。
  • 命名規則
    • 頻出するオブジェクトの命名則の統一(ros::NodeHandle を n にするか nh にするか、など)
    • 説明的な命名による可読性の向上(本文への影響が大で難しそう)

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

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

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

  • そもそもつい最近まで本文中のコードすら納品されておらずてんてこ舞いでそれどころではなかったよ!笑
  • 以降、対となる言語のコードを追加する分には、しれっと入れてもいいと思います。本文に影響はしませんし、読者が気づけばラッキーと思ってくれるでしょう。
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant