好湿?好紧?好多水好爽自慰,久久久噜久噜久久综合,成人做爰A片免费看黄冈,机机对机机30分钟无遮挡

主頁 > 知識庫 > 編寫Ruby代碼注釋時需要注意的一些問題

編寫Ruby代碼注釋時需要注意的一些問題

熱門標簽:湖州u友防封電銷卡 地圖標注賺錢項目注冊 電銷機器人廠商代理 滴滴外呼系統 徐州網絡外呼系統哪個好 常德電銷平臺外呼系統軟件價格 百度地圖標注自定義圖片 高德地圖標注客服 白銀外呼paas系統


    寫出自解釋文檔代碼,然后讓這部分歇息吧。這不是說著玩。
    使用英文編寫注釋。
    使用一個空格將注釋與符號隔開。
    注釋超過一個單詞了,應句首大寫并使用標點符號。句號后使用 一個空格

    避免多余的注釋。

  # bad
  counter += 1 # increments counter by one

    隨時更新注釋,沒有注釋比過期的注釋更好。

    不要為糟糕的代碼寫注釋。重構它們,使它們能夠“自解釋”。(Do or do not - there is no try.)

    注解應該寫在緊接相關代碼的上方。
    注解關鍵字后跟一個冒號和空格,然后是描述問題的記錄。

    如果需要多行來描述問題,隨后的行需要在 # 后面縮進兩個空格。

  def bar
   # FIXME: This has crashed occasionally since v3.2.1. It may
   # be related to the BarBazUtil upgrade.
   baz(:quux)
  end

    如果問題相當明顯,那么任何文檔就多余了,注解也可以(違規的)在行尾而沒有任何備注。這種用法不應當在一般情況下使用,也不應該是一個 rule。

  def bar
   sleep 100 # OPTIMIZE
  end

    使用 TODO 來備注缺失的特性或者在以后添加的功能。

    使用 FIXME 來備注有問題需要修復的代碼。

    使用 OPTIMIZE 來備注慢的或者低效的可能引起性能問題的代碼。

    使用 HACK 來備注那些使用問題代碼的地方可能需要重構。

    使用 REVIEW 來備注那些需要反復查看確認工作正常的代碼。例如: REVIEW: 你確定客戶端是怎樣正確的完成 X 的嗎?

    使用其他自定義的關鍵字如果認為它是合適的,但是確保在你的項目的 README 或者類似的地方注明。

您可能感興趣的文章:
  • 解讀Ruby中注釋的使用方法
  • 詳解Ruby語言中的注釋用法與中文編碼問題

標簽:梧州 公主嶺 荊門 三沙 普洱 張家界 遼寧 永州

巨人網絡通訊聲明:本文標題《編寫Ruby代碼注釋時需要注意的一些問題》,本文關鍵詞  編寫,Ruby,代碼,注釋,時,;如發現本文內容存在版權問題,煩請提供相關信息告之我們,我們將及時溝通與處理。本站內容系統采集于網絡,涉及言論、版權與本站無關。
  • 相關文章
  • 下面列出與本文章《編寫Ruby代碼注釋時需要注意的一些問題》相關的同類信息!
  • 本頁收集關于編寫Ruby代碼注釋時需要注意的一些問題的相關信息資訊供網民參考!
  • 推薦文章