日誌輸出規範

衆所周知,軟件日誌對問題的排查可以起到至關重要的作用,但在多人協同開發的情況下,可能會導致不同的人使用不同的日誌打印風格,導致日誌可閱讀性不高。縱觀各大知名軟件的輸出日誌,無不有着規範的格式,非常利於閱讀。縱觀網絡,現在鮮有對程序如何輸出日誌進行規範的文檔,本文嘗試定義一個日誌輸出方面的文檔。

  1. 日誌中使用英文;
  2. 日誌文件採用UTF-8編碼;
  3. 每條日誌首個單詞的首字母大寫;每條日誌以回車換行符(\r\n)結束,不需要寫句號.,如:
// RTC_LOG會自動在日誌結尾添加\r\n
RTC_LOG(LS_INFO) << "Forced software decoder fallback enabled";
  1. 不同語義間使用逗號,分隔,key-value間使用冒號:分隔,如:
RTC_LOG(LS_INFO) << "DataChannel received DATA message, sid: " << sid;
RTC_LOG(LS_INFO) << "Session: " << session_id() << " is destroyed";
RTC_LOG(LS_ERROR) << "Invalid configuration: " << config_error.message();
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章