![](https://images.logmi.jp/media/article/331348/images/main_image_428f593386a1100fe4799e824be362fcd0ef3ab1.jpg?w=600)
2025.02.03
創業125年のロート製薬が、新たな「気づき」を見出し続けられるわけ トヨタのカイゼンにならった「改鮮活動」の実践法
JuliaのDocumentationについて(全1記事)
リンクをコピー
記事をブックマーク
ガーシー氏:始めさせていただきます。今回は「JuliaのDocumentationについて」ということで、Jupyter使ってるので、Juliaで無駄にMarkdownを書いてレンダリングしてるスライドになってます。
こんなアイコンでだいたい活動していて、アカウント名はこんな感じです。僕はJuliaを使い始めて1年くらいで、今月名古屋から東京に転勤してきました。
名古屋で「機械学習名古屋」に参加したときに、最初に発表してくださったantimon2さんがJuliaの発表をしていて、「すごいおもしろい言語だ」と思って使い始めました。ふだんはWebの開発をしてます。
みなさんJulia開発するときってドキュメンテーション書いてますか?
(会場挙手)
そんなに……。パッケージを作られるときはたぶん書くものかなと思うんですけど。ドキュメンテーションは、例えばこういう関数を作るときこんなふうに文字列で書くと。
よくヘルプで呼び出すときの内容が吐き出されます。
さっきのコメントのところが、Juliaでドキュメンテーションと呼ばれるものです。例えば「+」のsearchで見てみると、こういう結果が返ってきます。
ここで中身の関数や型がどういうものを表してるのかを説明してくれます。
関数の、いわゆるドキュメンテーションコメントは、もともとコード中にただコメントを書くだけでした。
最初Pythonを使い始めて、PythonだとStringっていう概念で、それが文字列として返ってきて使えて、おもしろいと思っていたんですけど。
JuliaはなんとMarkdownで返ってきました。
さっきも「+」で見たときMarkdownでこう返ってきてました。なんかすごくオシャレで見やすい。
ここもMarkdownのドキュメンテーションなんですけど、Fieldsのcontentの中にMarkdownのrawテキストみたいなのが入っています。
ここだとArrayで2-elementって書いてあるんですけど、「+」だとこのドキュメンテーションは2ヶ所。Juliaは多重ディスパッチがあるので、それで複数の定義箇所から持って来てるので2つあります。
変数にも付けられます。変数に定義してドキュメンテーションコメントを書いていると、ヘルプでその変数のときも引いてくることができます。
関数以外にも付けられておもしろいなぁと思いました。
HTMLでも書けます。実際にこういうスクリプトを埋め込んだコメントを書いて、ヘルプを引くと……。まぁアラートが出てしまうんですけど(笑)。
(会場笑)
異質なコメントですね。
HTMLも全般書けるので、iframeとかも、僕の公式ホームページもレンダリングできます(笑)。
つまりiframe対策をこのWebサイトはしてないということです。
ちゃんとした使い方の例としては、TeXも書けるのでこういう感じでシグモイド関数を定義するときに、元の数式を定義しておきます。
画像もこういう感じで埋め込めるので「それがどういう特性を表しているのか」がけっこう見やすくなります。
ドキュメンテーションを動的に生成することもできます。
こういう数式を定義するような型を作っておいて、そこにgetdocのところで返ってくるドキュメンテーションの定義を置きます。
TeXの数式と実際の関数と画像を渡しておくと、さっきの型でインスタンスを生成したとき、ヘルプでこういうふうに(表示されます)。
いろんな数式を実装するときに使い回すこともできます。
時間になったので、これで終わります。ありがとうございます。
(会場拍手)
2025.02.06
すかいらーく創業者が、社長を辞めて75歳で再起業したわけ “あえて長居させるコーヒー店”の経営に込めるこだわり
2025.02.03
「昔は富豪的プログラミングなんてできなかった」 21歳で「2ちゃんねる」を生んだひろゆき氏が語る開発の裏側
2025.02.03
手帳に書くだけで心が整うメンタルケアのコツ イライラ、モヤモヤ、落ち込んだ時の手帳の使い方
2025.02.04
日本企業にありがちな「生産性の低さ」の原因 メーカーの「ちょっとした改善」で勝負が決まる仕組みの落とし穴
PR | 2025.02.07
プロジェクトマネージャーは「無理ゲーを攻略するプレイヤー」 仕事を任せられない管理職のためのマネジメントの秘訣
2025.02.05
「納得しないと動けない部下」を変える3つのステップとは マネージャーの悩みを解消する会話のテクニック
2025.01.07
1月から始めたい「日記」を書く習慣 ビジネスパーソンにおすすめな3つの理由
2025.02.06
落合陽一氏や松尾豊氏の研究は社会に届いているか? ひろゆき氏が語るアカデミアの課題と展望
2025.02.05
エンジニアとして成功するための秘訣とは? ひろゆき氏が語る、自由な働き方を叶えるアプリ開発とキャリア戦略
2025.02.04
生成AI時代に差をつける思考法とは? ひろゆき氏が語る「真のエンジニア像」