本人主攻java和c,所以按照這兩個語言的注釋方法,總結(jié)了幾個不錯的注釋習(xí)慣
一、負(fù)責(zé)人簽名
在文件開頭一定寫上創(chuàng)建的日期(甚至是時間),自己的姓名,這個文件主要是寫什么的,就是功能。
/*(后面為空)
(一個空格) *(一個空格)時間:1897/13/32
(一個空格) *(一個空格)姓名:一個有夢想的碼農(nóng)
(一個空格) *
(一個空格) *
(一個空格) */(后面為空)
(空行)
樣例:
/* * 時間:1897/13/32 * 姓名:一個有夢想的碼農(nóng) * ****:******** */大家可以在自己的編譯器中看一看,很漂亮。在最后有一個空行,根據(jù)個人習(xí)慣吧,我喜歡加上一個空行,有結(jié)構(gòu)感二、注釋中表格的畫法
在注釋中很少使用到表格,但是一旦注釋量大的時候,傳統(tǒng)注釋就會感覺很亂,而表格可以是整個頁面變得清爽。
/*
* +------------------------------------------------+--------------------------------------------------+---------------------------------------------------+
* +(一個空格)A1(至少一個空格) +(一個空格)A2(至少一個空格) +(一個空格)A3(至少一個空格) +
* +------------------------------------------------+--------------------------------------------------+---------------------------------------------------+
* +(一個空格)B1(至少一個空格) +(一個空格)B2(至少一個空格) +(一個空格)B3(至少一個空格) +
* +------------------------------------------------+--------------------------------------------------+---------------------------------------------------+
* +(一個空格)C1(至少一個空格) +(一個空格)C2(至少一個空格) +(一個空格)C3(至少一個空格) +
* +------------------------------------------------+--------------------------------------------------+---------------------------------------------------+
*/
大家可以在編譯器中看看,挺好看的樣例:
/* * +----------+-----------------+ * + date + 2016/11/12 + * +----------+-----------------+ * + name + aaaaa + * +----------+-----------------+ */
新聞熱點
疑難解答