search

chirimen-oh / chirimen.org

Tutorials for CHIRIMEN
https://tutorial.chirimen.org/
Mozilla Public License 2.0
3 stars 7 forks source link

コーディングルールを gc 配下の example に合わせる #54

Open dynamis opened 5 years ago

dynamis commented 5 years ago

example とのコーディングルール統一として gc 側の修正を行った https://github.com/chirimen-oh/chirimen-raspi3/issues/21#issuecomment-517090705

が合わせるだけでなく先行して実行タイミング制御 (onload から deferに) や mainFunction などについての扱いが変わっている。

tutorial 側もそれに合わせたい。

kou029w commented 3 years ago

Markdownコードブロックにコピペするのは簡単ですがメンテナンスし続けるのが困難なので、ページ読み込みは遅くなるのですが emgithub.com や CodeSandbox の埋め込みをつかってリンクさせるのが良さそうに思いました。

dynamis commented 3 years ago

example のコードを挿入するだけなら github のファイルを読み込んで埋め込む系のもので良いのですが、チュートリアルはその途中とか一部だけを抜き出したコードサンプルが大量にある (抜き出しだけなら出来るサービスはあると思うが行数指定だと元コードが変わると困る) ので example コードを参照させる形では解決不能ではないかと。

kou029w commented 3 years ago

行数指定だと元コードが変わると困る

それは適宜tagやbranchを指定しておくかcommit idを指定しておけば解決しませんか? 例: https://emgithub.com/chirimen-oh/chirimen/blob/8a3c6f438be396c0388dcf04ab2281c54645ae11/gc/gpio/LEDblink/main.js#L11-L11

dynamis commented 3 years ago

あ、はい。そうでした。タグを付ける限りそれの更新の手は真結局残りますけどコピペするよりはマシ＆前後の文脈のあるコードにリンクできたりするメリットがありそう。

example コードに存在しないコードというのもあるけど少数派だと思えばそこだけ諦めて Markdown 中に書くか、example 内に一緒に入れておいて同じフォーマットで参照しやすくするかというのは良さそうですね。

kou029w commented 3 years ago

section2 に関しては https://emgithub.com/ を埋め込んでみています。問題なさそうであればコードの整形・コーディング規約の変更とともに引き続き切り替えていくつもりです