格式

badge

任何不符合以下規則的文件都將得到更正

  • 以某種語氣寫代碼注釋或內部文檔
  • 向外部(普通用戶)展示的文檔應該越來越多地編寫
  • 始終包含定義、含義或文檔中首次出現的術語的鏈接
  • 僅對理解正文所必需的補充句子使用括號作為附加條件,對于理解正文不是必需的句子使用腳注1</ sup>
  • 如果文檔內容過時,按照此方法更新

1 參見這里了解如何編寫腳注。