注釋

◎ 注釋應放在其代碼上方相鄰位置或右方，不可放在下面。
◎ 注釋的內容要清楚明了，防止注釋二義性。
◎ 修改代碼時同步更新注釋，保證注釋與代碼的一致性。
◎ 函數聲明處注釋描述函數功能、性能及用法，提供參考范本如下：

/**
 * @brief    函數功能
 * @params 
 * @return
 * @par history
 *   xx create  @2023-xx-xx
 */

微信公眾號【嵌入式系統】提示，注釋格式可以參考Doxygen標準。

◎ 全局變量要有較詳細的注釋
◎ 函數內部注釋：函數內部不是注釋越多越好，而是變量命名和邏輯清晰，自注釋最好，特殊情況或者需要特別注意的地方才加注釋，并且注釋要放在代碼行的上方。
◎ 基于SDK開發，在基線工程上改動代碼，不允許刪除源代碼，修改代碼必須增加注釋，必須使用關鍵字“XX_CODE”標注修改原因，方便后續打補丁，范例如下：

/**** XX_CODE begin ****/
/*修改原因，作者，時間*/
< 代碼塊 >
/**** XX_CODE end ****/

對于非c源碼的文件，在這個注釋格式的基礎上，每行添加對應的注釋符號。
◎ 修改與外設驅動、通信協議、系統底層等相關的代碼，具有特殊隱含限制的代碼，必須提交詳細的修改原因，便于后續版本回溯查找原因。
◎ 復雜且相對獨立的功能，單獨使用markdown文檔說明開發方案、實現技術、應用場景、使用限制等，隨代碼提交。

排版與格式

◎ 程序塊釆用縮進風格編寫，每級縮進為4個空格。
◎ 相對獨立的程序塊之間、變量說明之后必須加空行。
◎ 多個短語句不允許寫在同一行內，長語句不能拆分需要分行寫。
◎ if、for、do、while、case、switch、default等語句獨占一行，｛換行且獨占一行。
◎ 賦值語句不要寫在if等語句中，或者作為函數的參數使用。
◎ 邏輯表達式每個子項都使用（）。
◎ if與else if/else必須以’{}’分隔，且 ‘{’與‘}’各占一行，if-else分3層以上必須以else子句結束，即使操作為空，并增加注釋://do nothing

if(var==xx)
{
  …
}
else if (var==yy)
{
  …
}
else if (var==zz)
{
  …
}
else
{
  //do nothing
}

◎ switch語句必須有default分支。
◎ 在兩個以上的關鍵字、變量、常量進行對等操作時，它們之間的操作符之前、之后或者前后要加空格；進行非對等操作時（如->），后面不應加空格。
◎ 文件編寫完成后，統一使用Astyle自動格式化工具整理一遍再提交到版本庫。

astyle.exe --style=allman -S -U -t -n -K -p -s4 -j -q -Y -xW -xV

微信公眾號【 嵌入式系統 】提示，可以參考《代碼的保養》；排版格式很多，一個團隊最重要的是統一風格。