はじめに
Qiita最近毎日頑張ってコツコツ書いてます。
よかったら、読んでくれると嬉しいです
間違えたりしているところあったら、すいません
ドキュメンテーションコメント
ドキュメンテーションコメントはAPIの仕様である。主にAPIを使用する人のために記述するもの。ドキュメンテーションコメントを見ただけで、そのAPIを正しく使えるようになっている必要がある。一般公開する目的っで作られたライブラリや、アプリケーション作成などの際も、開発効率を上げるなどといった目的があるので、ドキュメンテーションコメントを記述する必要があります。
RDoc
Rubyで書かれたソースコードから、ドキュメントを自動生成するライブラリ。クラスやモジュールの定義を抜き出し、includeやrequireに関して解釈をして、直前のコメントと合併し、HTMLを出力します。
コメント内で、見出しレベルを変えたりできる。また、クラスの関連図を画像出力など、便利なオプションもある。
ガード節
プログラミングの手法で、特定な条件を最初に処理することで、コードをわかりやすくする手法。
例えば、if文でネストが深くなってしまう場合、否定の条件で処理するとネストが浅くなり、ソースコードが見やすくなる場合があります。ネストが浅くなると読みやすくなります！合致する条件が多い場合で、条件が合致するかどうかのif文をたくさん作るより、合致しない条件(否定)でif文を作ったほうが、早いと思います(たぶん)
論理削除
データベース自体からデータ削除自体は行わず、削除されたとみなされるフラッグと呼ばれるカラムを設定することで、ユーザーには削除しているかのようにふるまうことができること。言い換えると削除されているように見えているけど、見えないだけであってデータ自体は残っているということ！
物理削除
実際にSQLでDeleteされることを指す。データベースから削除されるので、データの復元、削除されたデータの参照は不可。
隠しフィールド
プログラムには値を渡したいが、ブラウザ上には表示させたくないという場合に使用。
input タグの中でtype="hidden"を設定すると隠しフィールドの定義ができる。
さいごに
これからもっとたくさんコード書いて、自分にしか読めないコードではなく、「誰が読んでも理解できるコード」が書けるようになるよう努力していきたいと思います。