網(wǎng)站域名怎么轉(zhuǎn),lightsail wordpress,網(wǎng)站模板包含哪些內(nèi)容,做網(wǎng)站的商標(biāo)是哪類本文簡單整理了一下《高質(zhì)量 C/C 編程指南》注釋規(guī)范#xff0c;并非原創(chuàng)且作者在書中已明確準(zhǔn)許引用一、核心注釋規(guī)則#xff08;原文引用 極簡解讀#xff09;1. 位置要求【規(guī)則 2-7-6】注釋應(yīng)與其描述的代碼相近#xff0c;放上方#xff08;長注#xff09;或右方/C 編程指南》注釋規(guī)范并非原創(chuàng)且作者在書中已明確準(zhǔn)許引用一、核心注釋規(guī)則原文引用 極簡解讀1. 位置要求【規(guī)則 2-7-6】注釋應(yīng)與其描述的代碼相近放上方長注或右方短注不可放下方。解讀? 單行代碼注釋簡短注釋放右側(cè)與代碼隔 1-2 個(gè)空格長注釋放上方? 禁止放代碼下方易被忽略違背自上而下的閱讀邏輯? 示例// 修改 int 變量 4 字節(jié)值上方注釋*pi 0; // 賦值為 0右側(cè)注釋2. 內(nèi)容要求【規(guī)則 2-7-1】注釋是 “提示” 而非 “解釋”準(zhǔn)確簡潔無用則刪。解讀無需注釋顯而易見的代碼如int n 0;需注釋場景復(fù)雜邏輯、特殊算法、邊界條件、指針 / 內(nèi)存操作等如 char * 解引用修改單字節(jié)的大小端邏輯。3. 格式要求【規(guī)則 2-7-5】單行用//多行用/* ... */風(fēng)格統(tǒng)一。解讀VS2022 兼容 C 語言下的//單行注釋推薦優(yōu)先使用注釋內(nèi)容避免冗余如不寫 “給 n 賦值”可寫 “初始化 int 變量為十六進(jìn)制值”。4. 必加場景【規(guī)則 2-7-2】每個(gè)源文件頭部必須加注釋說明文件名稱、功能、作者、創(chuàng)建日期、版本 / 修改記錄。解讀示例C 語言/** 文件名稱mem_modify.c功能描述演示指針解引用修改不同字節(jié)長度的內(nèi)存值作 者XXX創(chuàng)建日期2025-12-16**/【規(guī)則 2-7-3】函數(shù)尤其對外接口必須加注釋說明功能、參數(shù)輸入 / 輸出、返回值、注意事項(xiàng)。解讀示例C 語言// 功能通過 char 指針修改 int 變量首字節(jié)// 參數(shù)pc - 指向 int 變量首字節(jié)的 char 指針val - 要修改的單字節(jié)值// 注意基于 x86 小端架構(gòu)僅修改低地址字節(jié)void modifyCharByte(char* pc, char val) { *pc val; }【規(guī)則 2-7-5】項(xiàng)目注釋格式需統(tǒng)一單行注釋用//多行注釋用/* ... */注釋首字符大寫。解讀VS2022 兼容 C 語言下的//單行注釋推薦優(yōu)先使用注釋內(nèi)容避免冗余如不寫 “給 n 賦值”可寫 “初始化 int 變量為十六進(jìn)制值”。二、VS2022 示例1. 源文件頭部注釋模板規(guī)則 2-7-2/* * 文件名稱xxx.c替換為實(shí)際文件名如mem_modify.c * 功能描述【簡要說明文件核心功能如演示指針解引用修改int變量不同字節(jié)長度的值】 * 作 者【你的姓名/昵稱】 * 創(chuàng)建日期【YYYY-MM-DD如2025-12-16】 * 修改記錄【無修改則寫“無”有修改則寫“YYYY-MM-DD - 姓名 - 修改內(nèi)容”】 * 注意事項(xiàng)【可選如基于x86/x64小端架構(gòu)char*解引用僅修改int變量低地址首字節(jié)】 */2. 函數(shù)注釋模板規(guī)則 2-7-3// 功能【核心作用如通過int指針修改變量全部4字節(jié)值】 // 參數(shù)【輸入/輸出參數(shù)說明無則寫“無”如n - 待修改的int型變量輸入/輸出】 // 返回值【如int - 0表示執(zhí)行成功】 // 注意事項(xiàng)【可選如解引用會(huì)覆蓋變量所有4字節(jié)內(nèi)容】 int modifyIntAllByte(int* n, int val) { *n val; return 0; }3. 單行 / 代碼塊注釋模板規(guī)則 2-7-6、2-7-1、2-7-5#include stdio.h /* * 文件名稱mem_modify.c * 功能描述演示int*和char*解引用修改int變量不同字節(jié)長度的效果 * 作 者XXX * 創(chuàng)建日期2025-12-16 * 修改記錄無 * 注意事項(xiàng)VS2022 x86/x64環(huán)境下為小端序char*指向int變量低地址首字節(jié) */ // 功能通過int指針修改變量全部4字節(jié)值 // 參數(shù)無 // 返回值int - 0表示執(zhí)行成功 int main() { // 初始化4字節(jié)int變量十六進(jìn)制值0x11223344小端存儲(chǔ)0x44→0x33→0x22→0x11 int n 0x11223344; int* pi n; // 定義指向int變量的指針右側(cè)簡短注釋 *pi 0; // 解引用修改n的全部4字節(jié)為0右側(cè)注釋說明操作 printf(n 0x%x , n); // 強(qiáng)制輸出0x前綴的十六進(jìn)制值預(yù)期結(jié)果0x0 // 重新初始化變量用于演示char*解引用效果 n 0x11223344; char* pc (char*)n; // 強(qiáng)制轉(zhuǎn)換為char*僅指向n的首字節(jié)低地址 *pc 0; // 僅修改n的首字節(jié)為0其余3字節(jié)保留預(yù)期結(jié)果0x11223300 printf(n 0x%x , n); return 0; }再次聲明并非原創(chuàng)、僅做引用之所以選原創(chuàng)是因?yàn)镺K還是經(jīng)典結(jié)尾嗯希望能夠得到你的關(guān)注希望我的內(nèi)容能夠給你帶來幫助希望有幸能夠和你一起成長。寫這篇博客的時(shí)候微風(fēng)正穿過紗窗輕拂桌面屏幕上的注釋與代碼在暖光里漸顯清晰。東華執(zhí)碼明規(guī)范萬里書山覓匠心。我走到陽臺拍下了一張宿舍對面的照片作為本文的封面。