質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

88.06%

「ここから何についての記述かを示すコメント」の書き方を教えて下さい

解決済

回答 2

投稿 編集

  • 評価
  • クリップ 1
  • VIEW 1,313

score 157

下記のようにコメントで、ここから特定のことに関する関数を記述するよと書いています。
このように目立つコメントを置くことで、ソースコードから目的の場所を探しやすくしているのですが、
やはりclassにまとめておくのが一番いいでしょうか?皆さんはこのようなコメントを書くことはありますか?

また、ページの章タイトルのようなものを記述する記法をご存知であれば教えて欲しいです。
JavaDocなどは決まった記述をするとドキュメントを生成してくれるので、そのようなもののために覚えておきたいです。

よろしくお願い致します。


##########
# csvの関数 #
##########

removeLastDelimiterOfCsv = (csvString) ->
  # 省略

concatWithCsv = (textElements) ->
  # 省略

createEmptyCsv = (columnNum) ->
  # 省略

#################
# localStorageの関数 #
#################

getRowFromLocalStorage = ->
  # 省略
  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 2

checkベストアンサー

+1

自動生成を意識するのであれば、ドキュメントジェネレーターの流儀に従うのが一番でしょう。
CoffeeScript対応のドキュメントジェネレーターとしてはdoccoという物があるようです。
CoffeeScript本家のAPIドキュメント生成もこれを使っているようなので、
特にこだわりが無ければ、doccoを使うときの書き方をしてみるというのはいかがでしょうか?

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2015/07/26 00:12

    CoffeeScript本家がdoccoというジェネレータを使っているのですね。
    教えていただきありがとうございます。

    ドキュメントジェネレータを使用して、それに沿った形で記述するのが良いのですね。

    キャンセル

0

関数をグループ化させる目的でクラスを用意するのはよろしくないですが、今回のような例ではクラスを用意したほうがいいと感じました。

# CSVを扱うクラス
class CSV

  # CSVのコンテンツを保持
  _content = ''
  
  # new CSV()で代用可
  create: ()->

  # Implement concat
  concat: (csv)->

  # Implement remove last delimiter
  removeLastDelimiter: ()->

# LocalStorageをラップして使いやすくしたクラス  
class LocalStorageAccessor
  # Implement get row from LocalStorage
  getRow: ()->

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2015/08/10 14:14

    関数をグループ化させることは良くないのですね。Utilクラスを作るのも良くないと見たことがあります。
    クラスはCSVとLocalStorageのラッパーを別々にすればいいのですね。
    ありがとうございます。

    キャンセル

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 88.06%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る