1. Yokohama North AM
  2. ep 37 @hiro_yとジャーナリン..
2021-01-28 59:20

ep 37 @hiro_yとジャーナリング、コードコメント、PHPerKaigiについて

00:06
こんばんは、Yokohama North AM第37回です。
Yokohama North AMは、ウェブ系エンジニアがテック系のキーワードをネタにして雑談をするポッドキャストです。
ホスト役は、自称フルサイクルエンジニアのハンハン1978です。
本日の相手は、ヤマオカさんです。
こんばんは、ヤマオカです。
こんばんは、よろしくお願いします。
よろしくお願いします。
Twitterで言うと、hiro__yさんですね。
はい。
合同会社、天窓、ひきいる、
ひきいる、ひきいる、2人しかいないけど。
フロント、フロント、フロント&バックエンド。
えーっと、なんでも屋さんですね。
なんでも屋さんです。
ということで、いつもお世話になっておりますという。
なんだそれ。
はい、いつもお世話になっておりますという。
いつもお世話になっておりますってやつですね。
あまりにも1月、頭にやる気がなさすぎてですね。
ゲストのアサインをずっと渋ってたらですね。
やべえ、いないってなって。
慌てて集めたところに手を挙げて頂いて。
よし、やるぞ。
おかげさまで、2月はちゃんとアサインが多いですね。
ヤマオカさんをお招きしてですね。
今日話したいことのトピックは3つほどありまして。
1番目がジャーナリングですね。
英語で言うとあれなんですけど、
要は日記とか振り返りの文章を毎日書くみたいな話。
2番目がソースコードのコメントの話ですね。
最近自分が会社で勉強会とかやったので、
ちょっとその話を話したいなと。
3番目がペチパー会議ですね。
ペチパー会議、本来2時からだっけ。
なんか1回ずれたよね。
それは後で調べようかな。
ですが2人とも実は登壇者として採択されたので、
ちょっとこのペチパー会議、今年はオンラインということで
ちょっとその話を最後できたらなと思います。
じゃあよろしくお願いします。
最初、ジャーナリングですね。
最近山岡さんが雑記を書いていると。
雑記を書いている。
雑記を書いているっていうか、
自分のホームページを始めたって言った方がたぶん楽しくて、
鍵かっこつきのホームページみたいなやつですね。
我々世代には懐かしい感じのやつです。
確かに。
今一応ハッシュタグつけて放流しましたけど。
03:02
放流された。
マジで昔懐かしい日記って感じです。
そもそも自分のホームページ改めて作ろうみたいなところは
プロフィール代わりみたいなところももちろんあったんだけど、
海外でインディーウェブっていう流れがあって、
自分のコンテンツとかを、
例えばメディアムとか日本人のノートとか、
そういったところに預けっぱなしにするのは良くないみたいな、
そういう流れがあって。
コメントとかもTwitterとかいろんなところであるんだけど、
コメントとかもなるべく自分のものに、
自分のデータとして持とうみたいな運動というか流れというか流行りがあって、
なるほどなと思って、
たまには自分で作るかと思って作ったのがきっかけです。
なるほど。
そして今更ながらホームページが出来上がったと。
これはホームページだなと思って。
これはホームページですね。
すごいホームページ感ある。
ホームページ感あるでしょ。
Twitterとかでもいいんだけど、
Twitterって文字数限られてるじゃないですか。
限られております。
なんか日本語書くの俺下手になってきたなって、
ふと思ったことがあって。
ちょっと長い文章を毎日書かねばいけないかなと思って書き始めたのが、
実はきっかけだったりします。
なるほど。
じゃあこれは振り返りとかってよりかは、
文章のテキストの練習みたいな性格が結構あるんですかね。
テキストの筋トレみたいな毎日やるぞみたいなところは最初はあって、
結局でも書いてることってその日あったこととかになるので、
必然的に出る前とかに書くと振り返りに近いような感じになったりすることが多いかな。
そうですね。
でもホームページになって残って後で見返せるっていうのはやっぱいいですよね。
Twitterとかだと残す気がないからね。
残す気ないですね。
振り返る気もあんまないからね。
インディーウェブって言うんですね。
なんでインディーなんだろう。
インディペンデント的なあれ?
そういうこと?
なのかな。
インディーウェブの世界は、
いろんなウェブメンションとかいろんな技術要素組み合わせて、
あとはマイクロフォーマットとか組み合わせてサイトを作るみたいな感じ。
基本はコンテンツを自分でホスティングするというか、
自分の元に集めるみたいな。
だからワードプレスのプラグインであったりとか。
なるほど。
06:00
だから必然的にPHPのライブラリが一番多いっていう。
これはでもPHPと親和性が高そうな活動ですね。
そうなんですよ。みんな大好き。
みんな大好きPHP。
そう、ワードプレスでも使えるし、
PHPでできてるCMSっぽいやつで、
knownってやつがあって、
それがインディーウェブに最初から対応してるよみたいなCMSなんだけど。
そもそも全然インディーウェブ知らないからめちゃめちゃ新鮮ですね。
なるほど、そういう考え方。
ちょうど昨年末ぐらいですかね。
ノートって実はエクスポート機能ないよねみたいなので、
ちょっとざわざわってしてたりした。
わかります。
まあ確かにそうだよなとか思いつつ。
でもワードプレスも今更なとか思ったりとか。
あとはNext.jsとかで作ってもいいんだけど、
うんとか思って。
なるほどね。
これでもなんかしきたりがあるんですね。
なんかどっかにRFCでもあるの?
特にないと思うんだよな。
たぶんHカードとかその辺使って自分を表して、
日記的なATエントリーとかちゃんと使って、
日記的なものをブログ的なものを書いてみたいな。
それだけだと思う。
そうなんだ。
結構悩むというか、
僕も自分のブログ持ってるんですけど、
ノートとか聞いたとか、
全とかには絶対上げないと思ってて。
自分のものは全部自分のとこに書いてやるって、
いつも思って書いてるんですけど。
そのブログを日記にしていいものかどうか。
なるほどね。
内容的に混ざる。
昔、日記のブログとテックのブログで分けてたんですよ。
分けてやってると、もうダメなんですよ。
力が分散しちゃって書かなくなっちゃう。
両方とも書かなくなっちゃう。
今日こっち書いたからこっちはいいやとかいろいろなって。
そうそう、なるんですよ。
同じIM8を僕は英語版を作るみたいなことでやったんですけど。
絶対書かなくなるやつだ。
絶対書かなくなるやつ。
そうなんですよね。
そう、だからKITとかZENもそうで。
ZEN、こないだ書いたけど、
書けば見てくれる場所という意味ではZENとかNOTEとかって
多分すごく良いし、いいんだろうなと思うんだけど。
とはいえ、そのサービスがずっと続くかっていうとどうかなって
思っちゃう部分もやっぱりあるし。
分かりもしかないですね。
そう、とはいえTwitterとかみたいに10年以上やってるサービスもあるけどさ、
09:00
とはいえ分からんからなって思うと
自分のとこ持ってたいなって気持ちの方が強かったりはする。
なるほど、なるほど。
でもいいな、インディウェブか。
ちょっと読んでみようか。
一応それっぽいAPIというか
仕様の寄せ集めみたいな感じになっていて。
あるんだ。
海外の人ってこういうの好きです。
好きというか上手いですよね。
こういう概念というか新しい思想の潮流みたいな形で出してくるのが
すごく上手だなと思って。
でもそれって別にさ、さっき話したけどさ、
我々の世代でいうところの、
昔のホームページじゃんみたいなところがすごくなくて。
そこに上手い名前を付けて。
今時のマイクロフォーマットとかに組み合わせて。
じゃあこれはあれですね。
古着がまた流行ってるみたいな。
もう1回来たみたいな。
もう1回来ましたみたいな。
MAはまた今年流行ってますみたいな。
それは昔、若い頃流行ったのよみたいなのがまた来たみたいなところはあるかもしれない。
なるほどね。
これちなみにじゃあ日本語の練習的にしてるけど
振り返りみたいな性格も持って。
持ってはいるね。
結局のところ今、いつ書いてるかというと寝る前なんですよ。
だから今日何やったかなっていう感じにはなっていて。
僕の場合働き方が一社で働いてるわけではなくて
いろんな会社のことをやっている関係上
自分のところ、自分の会社としての日報みたいなものは一応
記録としては書いてるんだけど
それとは別にプライベートなことを含めて書ける場所っていうと
こっちの雑誌になるのかなって感じ。
雑記から。
雑記。山岡さんっていうと雑記みたいな感じ好きそうだなって思いますね。
取り留めもなくね。
そうそうそう。ツラツラ書いてくるみたいな。
別にここで立派なことというか、主義主張を書こうとは何もしていないので。
だって詩とか書いてますもんね。
それはね、昔のものをそのまま残してあるだけですね。
これ昔のやつなんですか?ちょっと恥ずかしいですか?実は。
あんまもうそういう時期を過ぎた。
あ、その時期過ぎた。でもちょっと分かるように見えます。
40過ぎるとそういう時期過ぎます。
いやだってもう20年前とかになるわけじゃん。
もう俺こんなことやってたなぐらいの距離感になる。
僕もね、実は20年前に作ってた日記のサイトがあって、すげえいっぱいコンテンツあるんですけど。
分かる。
いまだに適当に動いてるんですけど。
昔はね、すっげえ恥ずかしかったけど、最近は別にいいかって。
なんかむしろ新鮮だなみたいになるじゃん。
12:00
すごいな。これがインターネットミームかみたいな。
実は探すと出てくるかもよとか。
それこそインターネットなんでインターネットアーカイブ、ウェイバックマシンとかで出てくるかもよみたいなところがあって。
面白いですね。10年単位とかで面白みが出てくるっていう。
インターネットも割とそうやって歴史を持つようにもうなってきているから。
だってツイッターだってもう13年とか14年とかもうやってるなと思うとすげえな。
やってますよね。
2009年とか8年とかに早い人が始めてたイメージなんで。
ちなみにちょっと伺いたいんですけど。
このブログってことは普通にキーボードでタイプして打ってるわけですよね。
キーボードです。
でもキーボード、スマホで書くことの方が多いかもしれん。
じゃあフリックとかフリック入力とか。
変わんないけどね。
なるほどね。
僕のジャーナリングは日記なんですけど、それはあれなんですよ。
手書き?
手書きなんですよ。
万年筆手書きっていうのが最近のずっとスタイルで。
ただ実際この業種が長くなってきたせいか、タイピングしてる方が脳の中身が素直に流れてくる。
わかる。
頭で考えてることと最終的なアウトプットの淀みの無さというか。
淀みの無さが全然いいんですよね、タイピングの方が。
直結してる感はあるよね。
そう、直結してるんですよ。
だけど手書きの方が遥かに残るんですよね。
記憶には残るんですよ。
頭だか手だかわかんないけど、どっか引っかかってるから逆に残るみたいなのがあると思ってて。
残ってるとか、文章の形とかその時書いた書き殴った文字の形みたいなのが、
普段は覚えてないんだけど日記読み返すと、こんなこと書いたなっていう記憶としては出てくるんですよね。
キーボードで打つのはただのテキストだから、
テキストの情報しか伝わらないんだけど、
手で書くものってテキスト以外にも伝わるものっていっぱいあって。
そうなんですよね、形なのか雰囲気なのか。
なんとなく書き方というか、そういうのも多分あるんだと思うしね。
で、その一方、頭の中身を素早くは出力できないから、すごいイライラするんですよね。
ちなみにそれって1日書くのにどれぐらいかかるんですか?
どれぐらいかな?日によるんですけど。
まあまあ、すんなり書ける時も多分あるし。
だいたい5分、10分ぐらいですかね。
15:02
まあでもそんなもんか。
5分、まあ10分かかることはあれかな。
まあ長いことやってるから。
まあね、割と寝訓練みたいなところあるだろうから。
で、これで気が済んでない時があって、
その時はノートPC開いて、
ダダダダダダダっていっぱいタイピングする。
長めにちょっと書こうみたいな。
そうそう。何々がムカついたとか何々が無かったとか。
それは紙に残さなくていいやつ。
そうそう。紙に残さないんだけど、
とりあえずインクドロップ使ってクラウドに保存はしてあるので、
後で読み返して恥ずかしいって思いはできる。
とりあえず頭の中からはストリームして出しておくみたいな。
そうそう。ストリームして出しとくみたいな。
吐き出すことが目的みたいな。
そうですね。残すのは副産物でしかないみたいなやつで。
そうなんですよね。この年になって物覚えもだんだん悪くなってくるだろうな。
出力の仕方とか記憶の仕方とかっていう中で、
いろいろ思うなと思って。
そうなんですよね。
昨日かな、ニュースでゼロ戦を千葉でずっと探してるっていう人がいらっしゃって、
そのニュースで出てきたのが、
目撃者がいらっしゃって、そのおじいさんが日記書いてたって言って、
何丁目何番のどこに何時ごろに。
細か。
そう。っていうのが全部詳細にズワーって。
すごいね。記録魔だね。
そう。記録魔の日記見て、うわ、すげえなって思って。
それ日記なのか。
日記なのか、もはや何でしょうね。
もはや何でしょうね。ライフログみたいな。
ログだよね。
すごいなと思って。
でもなんか、やっぱ残すのは素敵なことなんだなと思って見てましたけど。
残す、別に書いて振り返り的に今日こんなだったな、こんなこと考えたなって書いてはいるけれども、
これがじゃあ、別にこの先に役に立つと思って書いてるかというとそうではないし、
結果的に役に立つかもしれないけど別にそれは目的じゃないしみたいなやつなんですよ。
すごいわかりますね。ジャーナリングの目的ってあんまないじゃないですか。
そう、ない。
前日の状態を保存したものですよね。
その時に。
その時にそう思ってましたみたいな。
で、さっきのゼロ戦の話じゃないけど、別に出来事ではなくてこう思ったみたいなすげえ些細なことが書いてある感じだと思ってて。
18:03
でもあれだな、老後の楽しみとかにはなるのかもしれないけどね。
いやーやばいですよね。
さっき言ってた大学生の頃の日記のやつは10年ぐらい前に1回見たことがあったんですけど。
これはやばいなと思いました。
マジか。
これは恥ずかしいみたいな。その時はもうめちゃくちゃ恥ずかしかった。
多分、だいたい20年30年ぐらい経つといろいろ風化するんですよ。
あれですよね、恥ずかしいっていう部分が風化してそぎ落とされて。
これ黒歴史だなみたいなのが、いい思い出だったなに転化する瞬間みたいなのが多分あって。
ちょっとわかるような気がする、それ。
僕の場合はあれだね、大学の時に詩を書いてたりして文学部でそれやってて、
フリーペーパーとかも出してたので、あんまりそこの黒歴史って感覚を自分で意識しないようにしてきてるので、
あんまりね、その感覚ないんですよ、実は。
いいですね。残ってるってやっぱ素敵ですね。
当時作った、なんか自分のじゃなくて、当時まだ全然インターネットとかそんな流行ってなかったから、
でも始めてた詩人さんが何人かいて、そういう人のホームページとか僕作ってたことがあって、
そのホームページ実はまだ残ってて、この間ふっと消したら、
いや残しといてくださいよって言われて、見てたんだって。
その問題ありますね、いつまでメンテしないんだ問題が。
慌てて戻して、とりあえずファイアベースのホスティングに上げておこうかってなって、
今まだありますっていうのがあったりする。
なんかお墓とかだと永代供養ってありますけどね。
あるある。
ドメインとかってなんだろうね。
ホームページどうしたらいいのっていう。
永代ドメイン。
それこそ昔のね、昔のホームページとかさ、当時入ってたプロバイダーの中のホームページとかだったりするからさ、
もはや無かったりするし。
分かりますね、それ。
いつの間にか僕のも移動してて、全然ドメイン名も変わってて。
でも一応撮ってはくれてあるんだ。
そう、コンテンツは移動してるっていう、不思議な気持ちになる。
なので皆さんも、後で楽しいから、何でもいいから残しとくと面白いよっていう。
多分ね、何年語ったりすると面白いとか。
そうですね、趣がありますね、これは。
あんま成長につながるとか、そういうあんま真面目なのはないかもしれない。
そういうのを成長とか考えだすと多分辛くなって続かなくなる。
そうですね、そうなんですよ。成果を求め始めると腐るんですよね。
なんか別になんとなく自分が楽しいからとか、自分が後で読みたいからぐらいのなんとなくでいいと思う。
21:03
そうですね、それはしみるな。ほんとその通り。
よく目を出すとろくなことがない。
別にね、我々もそっちで物書きになろうと思ってるわけではないからさ。
そこは気楽でいいんじゃないかなって思っております。
では、そろそろテーマの2番目ですね。
コードコメント。
コードコメント。勉強会とかしたんすか?
そうなんですよ。会社でちょうど使用がわからないみたいな。
ドキュメントが足りないみたいな。そんな話とかになってきて。
よし、じゃあコメントをしっかりしようみたいなのをガイドライン作ろうみたいな話になったんですけど。
ちょうど社内勉強会みたいなのがあったのでやろうって話になったんですよ。
真面目にコメントのことを調べてみると、あんまりコメントについて真面目に書いてある本がないっていう問題が。
わかる。
虎の意を狩る狐じゃないんですけど。
お手本というか教科書的なものを。
あるといいなと思ったんですけど、結局2冊しか見つからなくて、
リーダブルコード。よく新人エンジニア読みなさいって。
読みなさいって言われるやつですね。
読みなさいって言われるリーダブルコードと、あとは僕がいつも推しているアフィロソフィーオブソフトウェアデザイン。
日本語訳が出てないやつがあるんですけど、これもソースコードコメントについて2章ぐらい。
逆に言うと他にはあんまないっていう。
確かにね。
意外とないんだなと思って。
むしろ勉強会の内容とかよりも、こんなに書いてないもんだと思って。
でも、我々ウェブ系のソフトウェアエンジニアやってるじゃないですか。
身の回り含めてコメントきちんと書きなさいって言われた経験のある人って大多数だと思ってて。
まあそうですよね。
どっかで先輩とか、新入社員の時とかに言われたことが誰でもあるんじゃないかなと思うんだけど。
実はお手本がなかったっていう。
そうですよね。お手本ないし、割と発言力のでかい人が、
要はわかりやすければコメントはいらないよみたいな。
流れもあるっちゃあるね。
出してくる時があって。
そう、だからこれはどっかでちゃんと教育せねばならんと。
ちなみに広瀬英夫ソフトウェアデザインの中に書いてあるのは、
コメントがなくてもわかりやすいぐらい行動を分割しだすと、そもそもわかりにくいと。
24:05
だからやっぱりコメントを書けって書いてある。
行き過ぎは良くないと。
ふざけんなぐらいで怒ってて。
いわゆるキレイみたいな方向に頑張りすぎると流れがわかんなくなるみたいなところは多分あって。
あの本の著者は多分JavaのAPIとかすごい嫌いなんですよ。
いっぱいインターフェースとかが。
クラスマニアックっていう単語が出てくるんですよ。
なるほどね。それは嫌いそうだな。
私は嫌いだって書いてある。
普通に手続きで書くよみたいな。それもわかる。
手続きでいいところは手続きで書けよみたいな。
それはむしろ外出しするなみたいな。
手続きがロジックなんだよみたいな話はある。
でもそうですよね。コメントってみんなどこで習うんだろうって思うと、
実はあんまり習ってない上にあんまり書物もないってなると、
それはおざなりにされるだろうなってちょっと思ったっていう感じですね。
でも一応多分これって文化とか会社にもよるんだけど、
僕とかは新人の時にSIだったわけですよ。
SIだと割とコーディング、今でいう規約かな。
規約みたいなのが割と決まってて、こういうドキュメントを書きましょう。
当時JavaだったからJavaDocに最終的にはなるんだけど。
JavaDocはこう書こう。あるいは行コメントみたいなところはこう書きましょうみたいな。
割と細かく決まってて。
そういう意味で会社の中にそういうお手本というか、何となくの例示はあった記憶はある。
それ言われて今めちゃくちゃ思い出したのが、
納品物の中に使用書って書いてあって、
うちはこれをJavaDocで済ませるって言って。
だからJavaDocをちゃんと書けっていう。
恐ろしいプロジェクトが1個あったなと思って今思い出したのかな。
何もないよりはいいけどね。
何もないよりはいいけど、JavaDocは使用書じゃねえなって。
インターフェース使用書的な。
そうですよね。PHPマニュアル納品されても困りますもんね。
確かに使い方は分かったけど、欲しいのはそれじゃないみたいな。
分かる。
多分そこだよね。
使い方とかはPHPでもそうだけど、コメントをちゃんと書くんだけど、
それ以外の部分のメソッドの途中とかに書くようなコメント。
そうですね。
何だっけ。
勉強会でまとめ直してた時に、
ものすごくいい文章が書いてあって、
コメントには何でこのようなことになってしまったのかを書けって。
27:04
フォワイを書けってやつ。
変なソースコードでも別に構わないと。
ただ、何故ここに落ち着いたのかを書けって書いてあって、
それはそうだなみたいな。
まあそうだよね。
コメントが欲しいなって思う時は多分、
これどうしてこうなってんのとか、
どうしてこの変数名なのみたいな時だと思ってて。
なぜなんだみたいなのもありますよね。
お前の書いた時はどういう気持ちだったんだみたいな。
多分いろんな歴史的経緯があるんだけど、
コミットログじゃそれがわからんみたいな時があって。
そうですね。
でもSIとかだと逆に、
ソースコード管理してるにもかかわらず、
古いコード全部コメントで残せっていう意味の。
あった。
これが入った時ね、まだJavaが入り始めて、
CVSが。
CVSっていうのがあったんですよ、若い人たち。
サブバージョンより昔のやつが。
ようやく入り始めたぐらいで。
CVSですよ。
僕が一番最初に使ったのはVSS、ビジュアルソースセーフ。
同年代なので大体同じものを経験してます僕は。
VSSで、
まだ現場によってはライブラリアンっていう人がいた時代なんです。
そうするとライブラリアンって何をする人かっていうと、
チェックアウト、チェックインをしてくれる人なんですけど、
そうするとチェックイン申請とかを出さなきゃいけなくて、紙で。
そうすると理由をちゃんと書くんですよ、これを直すからとか。
これがコメントだなと思いながら。
本当はね。
若い方は知らないかもしれないですけど、VSSとかはロックかけるんですよね。
チェックアウトすると他の人が触れないようになる。
そうなんですよね。
ロックしたまま夏休みに行くっていうあるあるがありました。
辛い。
誰だこれってなって。
管理者権限を持った人にロックを強制解除させてもらうっていう。
くだらないあるあるが。
あったあった。
そうなってくると結局今みたいに、
GitLogとかでDiffが全部出るぜみたいな世界観では当然ないので、
ないですね。
Diffっていう文化がそんなにまだ、
当然コマンドとかWindowsのソフトとかでは全然あったけど、
コミットごとにDiffを見るみたいな文化ってそんなにまだなかったから、
とりあえず処理を直す、共通処理を消すときはコメントで残そうみたいな文化は多分あって。
ございました。
30:00
何月何日に誰それがこういう理由で消しましたっていうコメントが残るっていう。
ソースコード中に消したソースコードの方が長いみたいな。
逆転現象が。
本体のソースコードどこだってずっと下の方にあるとか。
そうなんですよ。
でもVSSの後CVS時代はどれぐらいありました?1,2年はやりました。
1,2年はやったんじゃないかな。
割とすぐサブバージョンの方に行ったような記憶はあるけど。
そうですよね。僕もそんな記憶があって。
短かった。
僕の先輩かなんかがVSSダメだっつって。
これからの時代はCVSだっつって。
CVS導入し始めてみんなでこれはいいなみたいな。
楽観的ロックの思想はいいぞみたいな。
ゆるい共同作業いいぞみたいな。
どうせ同じとこいじんねーよみたいな。
って言ってたらCVSはよくリポジトリが壊れるっていう。
壊れるんだよねあいつ。
CVSのバックアップ必須だよねみたいな。
そうそう。あれでかなりみんな痛い目を。
割と壊れる。
割と壊れましたね。
CVSとかが流行った時代に多分Eclipseとかも同時に流行りだして
Eclipseから使えて便利とかそういう時代ですね。
そうですね。
その後SVNが出てきてリポジトリが壊れないって言って。
すごいみんな感動した。
本当それ。
割と無茶しても大丈夫だっていう。
大丈夫壊れないぞって言って。
で後Dartos SVNとかが。
あれはあれで使いやすかったすごく。
歴史ですね。
だから多分その頃に話されてたコメントっていう概念と
我々が話してるコメントって概念が多分ズレがあるんだろうなっていう気もしていて。
そうですね確かに。
割と昔だとJavaしかなかったようなドキュメンテーションのツールが今PHPでも普通に
PHPドキュメンテーターとかで出てきて。
PHP Stormみたいにアノテーションコメントみたいなところをきちんと拾って
IDEのヘルパーとしても使えるようになって。
そういった意味で開発効率を上げるためのコメントと
さっきで言うホワイトが意図を伝えるためのコメントと
多分2通りあって。
2通り目の意図とか
なんでこんなことしたんみたいなところを伝えるコメントの書き方って
確かに我々習ったことはないし。
でもなんとなくやっていて。
33:01
自動でチェックできないコメントですよね。
PHP Dockとかだと静的解析とかで洗えるかもしれないけど
理由とかは書けない。
ちょっと検出しづらいですね。
よくあるそれこそネタになるようなコメントも多分今まであって
どうして動かない、なぜかこうすると動くみたいな。
でも割と最近言わして
ToDoってこの処理は読まれないって書いてある。
ToDoコメントに残りがち問題とかね。
消せやと思って。
ToDoってIDによってはちゃんと拾って一覧にしてくれるんだ。
一覧にしてくれますね。
大体いっぱいある。
ToDoFixMeですね。
これ誰がやるのかなみたいなのが残り続けるみたいな。
とかもはや仕様が変わってるとかね。
ToDoこの処理は読まれないわ。
本当に読まれないと思う。
もう散々時間かけて確認して消しました。
なんだろうね。どうしたらいいんだそういうのっていう。
この人はなぜこの時これを書いたみたいな。
ToDoって割とチーム開発っていうか個人のメモになりがちじゃないですか。
そうですね。
お気持ちみたいな。
だから同時に開発してたはずなのにわからんみたいなことも起こって。
コメンティングは確かに習わないですね。
習わないし、書籍もあんまないし。
そうなってくると現場で培う知識になってきますよね。
ベストプラクティス的なものを過去のコードとかを見てやっていくみたいな感じなのかな。
だから今は日本語だったらもうリーダブルコードを読むしかないですね。
一択だった。
一択リーダブルコードを読め。
ちなみに全然覚えてないんだけど、どんなこと書いてあったの。
ちょっと待ってくださいね。
手元にねえや今。
会社に置いてある気がする。
割といいことが書いて、割といいことっていうか、いやリーダブルコードはいいこといっぱい書いてある。
なんだったかな。コメントすべきこととコメントすべきでないことみたいな。
見てわかるのは書くなみたいな。
ifなんちゃら、いやこのif見りゃわかるよねみたいな。
コンストラクターにコンストラクターって。
なんか書かなきゃいけないからしょうがないから書くやつ。
ぶっ飛ばすぞみたいなやつ。
書籍の例だとセットプロフィットのコメントに、プロフィットに新しい名を設定するって書いてあって、これは書かなくていいって書いてある。
36:09
まあわかるってやつ。
あとはなんだろう。ひどい名前はコメントをつけずに名前を変えるとか結構実践的だな。
まあね。さっきのだからコメントがないのが理想だよねってのも一理はあって。
でも一応ありますね。コードの欠陥にコメントを作るのところにto do fix me hack xxxって書いてある。
そっちか。
CSSの文化だとhackって書きますよね結構。
定数にコメント作るとか読み手の立場になって考える。
割とだからね全部を統合、まとめるとAPOSDもだいたい同じこと書いてて。
要はコメントも含めてソースコードが読み手にとって読みやすくなってるってことが一番いいよって書いてあって。
まあそりゃそうだなっていう。
だから別にコメントってさっきからコメントの話をしてるけどコメントで独立したものではないからコメントも含めたソースコード。
そうですね。APOSDにすごく的確な当たり前のことが書いてありましたけど、コメントを編集してもバグが生まれないって書いてありました。
まあなっていうあれだけど。
まあなっていうあれだけど、いやそうだなっていう。
改めてコメント足しても別にバグにはならない。
うん。だから書けることはちゃんと書いておくと多分後々誰かが助かったりするよっていう。
そうですね。なんか前そういえばC言語かなんかかな。コメントがあると動くコードっていうのがあった気がするけど。
ネタですけど。
ここにコメントを入れるとなぜか動くみたいな。
そうそうみたいなそうそうそうそう。
ループの途中に一回挟むと動くみたいな。どういうことだよって。
なんかね解説読んだらねすごいすごい理由だったんですよ。なんかねアセンブリで出力されたときとか。
変わるんだ。
そう。位置がね一個ずれてコメント入れると動くようになる。
ちゃんと理由があった。
そうそうバグらしいんですけど。
絶対バグだよね。
コメントでコンパイル結果変わったらあかん。
そうですね。
なのでコメントについてはですね。日本人の方はリーダブルコードを読むと。
だいたい新しめのことが書いてある。
あとは最近だとオープンソースのソースコードが割といっぱいあって。
ちゃんと選んで読めばちゃんと書いてあるので。全然書いてないオープンソースの結構あるけど。
ありますね。
すげー困るな。
わかる。
39:00
ドキュメントが間に合ってないのはまだしょうがないかなと思うんですけど。
ソースコードのコメントもないとコード読んでももうわからないっていう状態になるので。
勘弁してほしいってなりますね。
それも含めてオープンソースにしてほしいみたいなところは。
PHPだとあれかな。シンフォニー系のやつとかは割とちゃんと書いてある。
書いてありますね。
いろんな人が携わっていると必然的に書くんだなとか思ったりするし。
最悪ソース読めばなんとかなるみたいな感じはあるんで。
PHPとかだけじゃないけど最近だとオープンソース界は中国語のコメントもいっぱいあって、
これなんて書いてあるんだって翻訳したりしますね。
ドキュメント系もそうですね。
極めて俺の知りたそうな情報が書いてあるページだが中国語でわからない。
これは詳しく書いてあるに違いないっていうのに限ってそうだったりするから、
このライブラリーの作者さん中国の方だったんだ。よし、頑張ってみるぞってなる。
翻訳でテキストはいけるんですけど、画像に文字が書いてあるとかって。
それがすごく確信的な、そこが確信だろうっていう情報がわからない。
そこがわかりやすいところなんだろうなっていう。
でも今考えたらあれだな、Googleトランスレートであれがカメラで撮れば翻訳できたら。
カメラならいけるんじゃない?
カンパンとかできるんだよね。
いけるいけるいける。
だから画像もいけるんじゃない?
ちょっともう一回チャレンジしようと思って。
オープンソースなので、別に英語だけじゃないし、
フランス語とかもたまに見かけたりするし。
結構厳しいですね、フランス語とか。
これ何語だっけだ、多分フランス語かなみたいな当てをつけて。
いや、わかりますね。
という感じで割とコメントが盛り上がったな。
盛り上がった。
とりあえずじゃあリーダブルコードを読めと。
そうですね、リーダブルコードを読めということですね。
リーダブルコードしかないんで、リーダブルコード読んでください。
いい気がする。
目次上は達人プログラマーにはなかったんで。
多分ね、書き始めて最初のうちコメントどうしようかとか考えないと思うし、
言われもしないと思うんだけど、
ある程度書くと、もっとこうした方がいいよとか、
書いとけばよかったなとかって思うと思うから、
ちょうどリーダブルコード読んだ方がいい時期と重なる気はします。
確かに。
そうですね。
エンジニア成り立てでリーダブルコード読んでも訳わかんないじゃないですか、きっと。
確かに。
ちょっと経験しないと痛みとかコンテキストがね。
ついにテーマの3番目に向かいますが、
42:04
フラチにも日付を忘れてしまったペチパー会議2021ですが、
3月26日から28日の3daysです。
3days。
いやー。
オンライン開催。
オンライン開催です。
2人ともスピーカーとして応募して無事採択ということで。
採択されました。
おめでとうございます。
おめでとうございます。
おめでとうございます。
なんだこれ。
山岡さんのやつ、フォルテのページが分かるのかな。
DIコンテナ、実は去年か。
去年のペチパー会議でも僕は登壇していて、
おとみどころ話してるよね。
何喋ったかな。
去年僕はPHPのアノテーションって話を実はしていて、
当時まだPHP8が出てなくて、
アトリビュートに関しては一応触れずに済ませたやつなんですよ。
RFCとか出てたかな。
もう8が出てアトリビュートが使えるようになっていて、
それで多分ライブラリが色々変わってきていて、
その辺の話も含めてDIについて改めてみたいなところと、
今後どうなるのかねみたいな、
過去に振り返りつつみたいなことをやろうかなと思ってます。
でもPHP8でしか動かないライブラリなりフレームワークは増えてきそうですよね。
アトリビュート色々やりたくなっちゃうんだろうな、きっと。
分かる。やりたくなるですよね。
これならこれができるみたいな。
そうですよね。Javaから来た人とか夢見ちゃいそうな気がする。
Javaで言うアノテーション的なことがちゃんとできる。
絶対やりますよね。ルート定義をアノセーションでみたいな、
アトリビュートでみたいな、そういう。
ララベルシンフォニーがなってるのかな。
シンフォニーがルート定義アトリビュートで書けるように、確か語でなってる。
これもでもあれですよね。書き方に慣れるとか概念に慣れるとかしないとちょっと使いづらいというか。
そうね。多分何かアトリビュートを自分で実装するってケースはそんなにないはずで。
だからこそかな。実装してみて、こう動くんだみたいだと、
これが一通りやんないとアトリビュートのソースコードを理解できないかもなっていう感じがちょっとあるなと。
そうそう。だからDIのインジェクションのことをアトリビュートで書いたりとか、さっきのルーティング書いたりとかっていうのが今出てきている流れだけど、
45:04
結局じゃあそう書いたら何が動くのかって見ないと分かんないし、分かんないと気持ち悪いと思っちゃう勝負なので。
分かりますね。僕もそうですね。何やってんだこれってなったら。
知らないまま使うの気持ち悪いって感じなだけかな。
そうですね。なるほど。じゃあぜひアトリビュートとかDIに興味がある人は山岡さんの話を聞こうと。
基本初心者というかPHPに強くない人向けの話にしようと思っているので、
アトリビュートって何じゃみたいなところから、別にアトリビュートの実装がこうなってるよって話はあんまりするつもりなくて。
良いですね。良さそうですね。
割と初心者向けを中心に最近やっています。
割とでも分かります。ちょっと初心者向けのトークとかスライド作ると後で引用しやすいですよね。
引用しやすいしされやすい。
これ見てねーとか言いやすい。
何年か前に仙台で話したミドルウェアとかHD的なハンドラーの話、割と図が一人歩きしちゃった。ちょっと面白かったので。
ありますありますあります。
そうそうそう。
富本コロさん何話すんだっけ。
僕はですね、実はここ3年間ぐらいずっとこの同じタイトルをいろんなところに投稿し続けて、
ついに採択されたPHPで学ぶセッションの基本の応用というやつですね。
この世の中にセッションが分かってないパターンが多すぎてですね、いい加減困ると。
セッション、多分ウェブのエンジニアとかウェブに関わってたらどっかしらで絶対関わってるはずで。
そうなんですよ。
でもフレームワークとかも進化しちゃったじゃないですか。
そのせいでCSRFとかトークン周りとかっていうのはあんまり生で使う。
そもそも仕組みとして自分で作る必要がなくなっちゃうんで、そうすると触れる機会がなくなってくるんだろうなっていう気がします。
セッションって言葉をそもそも使わないメソッドとか結構あるもんね。
Flashとかもそうだけど。
ララベルとかも結構いやらしいじゃないですか。
いわゆるララベルの普通の使い方していくと、要はフォームリクエストでバリデーションでエラーで返ってきたときってリライデックとしてセッションの中身に入っているエラーメッセージを出すんだけど、
そこは全然意識しないじゃないですか。
オールドってどこから来たんだってやつ。
そうそうそうそう。
あの中で実はセッションの中身がリダイレクトされた回数に応じて中身がリフレッシュされて、
48:02
差し替わっていく。
そう、差し替わっていくとかっていうのを、理解していこうぜっていうゲームの活動とかね。
そう、だからまあ案外今表に出てこなくなったセッションみたいなところに光をもう一回当ててみるみたいな感じか。
そうですね。あとはアーキテクチャに結構関わってくるんで、セッション。
まあ間違いなく関わるよね。
はい、その、なぜ私はログイン状態なのかみたいなところ。
そう、今ログインってさ、自分で実装どれぐらいの人がするかみたいなところあるじゃん。
ありますね、ありますね。
フレームワークとか特に使っちゃうと。
で、シングル構成で1台でやってたらいいかもしんないけど、
LBとか送ってなったらセッションの解決でじゃあどこでしますかっていう話がどうしても出てくるはずなんだけど。
じゃあストレージってのが必要だよねみたいな話が。
そうそうそうそう。
あなたの会社のウェブアプリケーションは何も変わったことがしたくてレディスにセッションを入れてるわけじゃないよみたいな。
何も好き好んでデータベースに入れたくてやってるわけじゃないんだと。
複数で構成にするとなっていう。
そうそうそう。意味があってやってるんやでっていう。
そこを理解する橋渡しになるといいなみたいな。
セッションね。
逆に生でセッションって使わなくなってきてるから、
ちょっと昔で言うとセッションに何でもかんでも入れて。
いやでもね、割と見るんだよな。
取っ払えるみたいなのあったじゃん。
確かに入れておくと便利なのはわかるけどさみたいな。
便利なのは間違いないですよ。
とりあえずリクエストごとの情報を引き回すのには入れておくと便利だよねみたいなのがあって。
容量無制限のクッキーみたいなもの使って。
よしユーザーテーブルの中身全部持っちゃうぞみたいなさ。
できるけど。
なのでここでちょっと1回、聞いたじゃない聞いたよりもうちょっと真剣に。
いや別に聞いたを貶めてるわけではないですけど。
たまに変なの引っかかっちゃうんで。
でもそうね、セッションについて普通に話せばたぶんスッて終わっちゃうんだけど、
さっきのコメントの不愛の話じゃないけどなんでそんなことをしたんだっけみたいな歴史的背景だったりとか。
そうですね。そういえばあれですよこれ。
ラベルJPコンで採択されてたんですけど。
あー。
去年中止になっちゃったから。
幻の。
51:00
幻のリベンジプロポーター。
そうだったんだね。
1年越しの。
1年越しの。申し訳ないもん。
この1年でもしかしたらセッションで悲しい事件を起こしているウェブアプリ消しが増えてしまったかもしれない。申し訳ない。
止められなかった。
全部コロナのせいで。
セッションね。PHPだと昔だと大文字セッションってグローバル変数で書かなきゃいけなかったから逆に意識できてたんだけど。
ダメですもうそれは。そんな話しかダメです。
スーパーグローバルが。
ダメです。スーパーグローバルの話はやめてください。
まあ余計に便利に使えるっていうあれもあったけどね。
そんなものはありません。
まあ大きなグローバル変数になっちゃうっていうね。
昔、いやしまったもうこれ以上怖い話をするなよ。
はい。
スーパーグローバルの中身を編集する話はやめよう。
ドキドキするね。
ドキドキするやつ。
なのでこの3DAYSペチパー会議。
あれなんですね。ニコニコ動画なんですね。
ニコニコ。ニコ生?ニコニコ?わからないけど。
配信でやるらしいので。
あれですね。我々も事前録画。
するらしいね。録画は初めてだな。
事前録画が3月14日までですね。
だから28日までだと思ってると痛い目になってしまうので。
そう。だから開催日より前に色々準備しなきゃいけないっていうやつですね。
逆に開催日はみんなと一緒にコメントを出せるみたいな。
そう。開催日逆にどうしたらいいのかな。
普通にコメントすればいいのかなって逆にちょっと困る感じ。
そうですね。ワロタとかだし。
なんかあれだね。オーディオコメンタリーみたいな感じで言えばいいのかな。
なので今度は今度こそ開催日前に資料作成が終わるっていうことが保証されて。
当日済みでやる姿みたいなのは今回は誰もいないはずです。
そうですね。多分。
14日って言ってるけど、実は多分泣きで21日くらいまで録画してるじゃないですか。
何を織り込んでるの。
いや、大丈夫です。生まれ変わったんで。
もう前もって作る。
生まれ変わったんでちゃんと前もって作ります。今度こそ。
ちなみにあれですよね。ペチパー会議は今月中に多分チケットを買うとアーリーバードとかでちょっとお安くなるはず。
そうですね。なんと僕はもう買ってますね。
登壇者買う必要あるのかな。よくわかんないけどいつも買っちゃうから。
54:00
ちゃんと登壇者のは別にあるので。
でもあれじゃないかな。一般向けノベルティーがもらえるからこのままでは。
それはそれでありかもね。
ノベルティー問題。
ノベルティー問題がありますので。
本当だ。2月1日12時に販売終了って書いてあるのでぜひ皆さん購入して。
なので一つでもお安く。
そうですね。
ペチパー会議絡みはこんなとこかな。
そうですね。思い出しますね。去年。
去年のペチパー会議がリアルカンファレンス僕は最後。
ちょうどこのコロナみたいな騒ぎになるちょっと前ぐらいだったよね。
まだ誰もそんなマスクとかしてないぐらい。
その後になんだっけ。オブジェクトカンファレンスかなんかが1週間後にあって。
僕はそれも言ってて。
それが多分リアルカンファレンス最後。
最後ですよね。
その後は全部キャンセルキャンセルオンラインみたいな感じになってる。
ちょっとこの未来は予想してなかった。
そう。なかなか。
逆に言うとオンラインカンファレンスを目いっぱい楽しめる。
ラストイヤーかもしれないですね。
そう。だから場所関係なく参加できるし。
まあ物によってはアーカイブとか含めてちょっと時間ずらしても楽しめるみたいなところもあるだろうし。
そうですよね。
多分でも去年から1年ぐらいかけてみんなライブ配信のノウハウがめちゃくちゃたまってるじゃないですか。
多分ペッチパー会議が長谷川さんとかえらい溜まってると思うんだよね。
えらい溜まってますよね。
マイクの音質もめちゃくちゃいいからな。
機材勝負みたいなところは配信ってあるじゃないですか。正直なところ。
そうですね。
いやーなのでちょっと楽しみですね。
一応多分オンラインオンリーは来年には普通のカンファレンスできるんだって。
カンファレンスとか勉強会とかがまたできるといいなとは思いつつ。
そうですね。
ただオンラインもオンラインで残るといいなっていう気持ちもあるし。
あります。割と離島とかから見てるとか、このポッドキャストも離れたところから聞いてるとかアメリカからも聞いてるみたいな。
すごくいいなと思って。
何か過事しながら聞ける見れるとかも多分あるし。
ありますよね。
57:01
そういった意味で質素の広げる意味も多分あるので、オンラインはオンラインでうまくハイブリッドになるといいなっていう気持ちはある。
そうですね。人類は進化したな、この1年。
いかなくてもいける。
いかなくてもいけるみたいな。実はやれてたみたいな。
なんだできるじゃんみたいなところはある。
って言っていると見事に1時間経ちました。
そうですね。
いやーほんと。よかったよかった。
じゃあそろそろ終了の儀式に行きますね。
どうぞ。
何か言い残しとかありますか?
言い残したこと?まあ登壇するよっていうのは言っちゃったし、そんなもんね。
そうですね。そうですよ。というかみんなも登壇しましょうと。
登壇しましょうだし、いきなり登壇するのはやっぱり怖いよねって思うのは当然だと思うので、
まずは1回見てみる、参加してみるっていうのをやってくれるといいのかなと思って。
怖くないよっていうのが多分分かる。
怖くないですね。
多分登壇しているほとんどのおじさんたちはいきなりツイッターでリプライとかとつられても優しく答えてくれる人が多いですよね。
特にPHパワーはめちゃくちゃそういう人が多い。
なんでそんなことも知らねえんだ、調べろみたいな人はいないと思うので。
いないですね。逆に粘着質に教えてきそうですよね。
すっごい丁寧に。
丁寧に教えてきそうなんで。
だから全然どういう勉強会がありますか?だったりとか、どういうのがいいかなとか全然聞いてくれてみんな多分心よく答えてくれると思うから。
そうですね。そういうネットワーキングにも使えると思うので。
ぜひ参加してください。
いいと思います。
はい。では。
今週も放送を聞きいただきありがとうございます。番組のフィードバックや要望はハッシュタグ横浜のせいもつけてツイートしてください。
本日のお相手は山岡さんでした。ありがとうございました。
ありがとうございました。
横浜のせい。
59:20

コメント

スクロール