編寫高質量Dart程序-文檔註釋參考

註釋 要像句子同樣格式化評論。 不要在文檔中使用塊註釋。 Doc註釋 使用///文檔註釋來記錄成員和類型。 優先爲公共api編寫文檔註釋。 考慮寫一個庫級別的文檔註釋 考慮爲私有api編寫文檔註釋。 用一句話總結開始doc註釋。 必定要把「doc註釋」的第一句話分隔成本身的段落。 避免與周圍的上下文冗餘。 優先用第三人稱動詞開始函數或方法註釋。 優先用名詞短語開始變量、getter或setter注

>>阅读原文<<