arm_memcpy注释
/*
* linux/arch/arm/lib/memcpy.S
*#define LOADREGS(cond, base, reglist...)\
* ldm/**/cond base,reglist
*所以展开就是ldmfd sp!,{r0, pc}[gliethttp]
*
*/
#include
#include
#include "constants.h"
.text
#define ENTER \
mov ip,sp ;\
stmfd sp!,{r4-r9,fp,ip,lr,pc} ;\
sub fp,ip,#4
#define EXIT \
LOADREGS(ea, fp, {r4 - r9, fp, sp, pc})
#define EXITEQ \
LOADREGS(eqea, fp, {r4 - r9, fp, sp, pc})
/*
* Prototype: void memcpy(void *to,const void *from,unsigned long n);
* ARM3: cant use memcopy here!!!
*/
ENTRY(memcpy)
ENTRY(memmove)
ENTER
cmp r1, r0 ;比较from跟to
bcc 19f ;r1 subs r2, r2, #4 ;对拷贝数量减4，返回时加回去 blt 6f ;剩余拷贝数量不足4字节 ands ip, r0, #3 bne 7f ;目标地址未4对齐 ands ip, r1, #3 bne 8f ;目标地址4字对齐，但源地址未4对齐 ;目标地址、源地址均4字节对齐，进入这里r2已经减4 1: subs r2, r2, #8 blt 5f ;拷贝数不足4+8=12字节了 subs r2, r2, #0x14 blt 3f ;拷贝数不足4+8+20=32字节了 ;目标地址、源地址均4字节对齐，且拷贝数>=32字节,进入此段r2已经减32 2: ldmia r1!,{r3 - r9, ip} ;读32字节 stmia r0!,{r3 - r9, ip} ;写32字节 subs r2, r2, #32 bge 2b ;还有32字节以上，则继续循环 cmn r2, #16 ;拷贝数不足32字节，r2已<0，与-16比较 ldmgeia r1!, {r3 - r6} ;还有至少16字节需要拷贝 stmgeia r0!, {r3 - r6} subge r2, r2, #0x10 3: adds r2, r2, #0x14 ;用以判断是否还有12字节 4: ldmgeia r1!, {r3 - r5} stmgeia r0!, {r3 - r5} subges r2, r2, #12 bge 4b ;目标地址、源地址4字节对齐，且拷贝数小于8字节，进入此段r2已经被减8 5: adds r2, r2, #8 ;r2恢复 blt 6f subs r2, r2, #4 ldrlt r3, [r1], #4 strlt r3, [r0], #4 ldmgeia r1!, {r3, r4} stmgeia r0!, {r3, r4} subge r2, r2, #4 6: adds r2, r2, #4 ;开头对拷贝数量减4了，所以返回时加回去 EXITEQ ;已经拷贝完，返回 cmp r2, #2 ;拷贝剩余字节 ldrb r3, [r1], #1 strb r3, [r0], #1 ldrgeb r3, [r1], #1 strgeb r3, [r0], #1 ldrgtb r3, [r1], #1 strgtb r3, [r0], #1 EXIT ;目标地址未4对齐，进入此段同时表示有>=4字节要处理 7: rsb ip, ip, #4 ;反向减4，得出要处理字节数，例如目标地址为5 ;则未对齐数为4-（5&3）= 3 cmp ip, #2 ldrb r3, [r1], #1 ;未对齐所以至少有一个，故先读写一个 strb r3, [r0], #1 ldrgeb r3, [r1], #1 ;如果未对齐数量大于等于2，再读写一个 strgeb r3, [r0], #1 ldrgtb r3, [r1], #1 ;如果未对齐数量为3，则再读写一个 strgtb r3, [r0], #1 subs r2, r2, ip ;修改拷贝数量，此时ip存的是未对齐数量 blt 6b ;剩余 ands ip, r1, #3 beq 1b ;源地址已对齐 ;目标地址4字对齐，但源地址未4对齐 8: bic r1, r1, #3 ;得出源地址指向的字 ldr r7, [r1], #4 ;载入这个字 cmp ip, #2 bgt 15f ;未对齐偏差为3，例如源地址为3， ;此时未对齐字节数为1 beq 11f cmp r2, #12 blt 10f sub r2, r2, #12 9: mov r3, r7, lsr #8 ldmia r1!, {r4 - r7} orr r3, r3, r4, lsl #24 mov r4, r4, lsr #8 orr r4, r4, r5, lsl #24 mov r5, r5, lsr #8 orr r5, r5, r6, lsl #24 mov r6, r6, lsr #8 orr r6, r6, r7, lsl #24 stmia r0!, {r3 - r6} subs r2, r2, #16 bge 9b adds r2, r2, #12 blt 100f 10: mov r3, r7, lsr #8 ldr r7, [r1], #4 orr r3, r3, r7, lsl #24 str r3, [r0], #4 subs r2, r2, #4 bge 10b 100: sub r1, r1, #3 b 6b 11: cmp r2, #12 blt 13f /* */ sub r2, r2, #12 12: mov r3, r7, lsr #16 ldmia r1!, {r4 - r7} orr r3, r3, r4, lsl #16 mov r4, r4, lsr #16 orr r4, r4, r5, lsl #16 mov r5, r5, lsr #16 orr r5, r5, r6, lsl #16 mov r6, r6, lsr #16 orr r6, r6, r7,LSL#16 stmia r0!, {r3 - r6} subs r2, r2, #16 bge 12b adds r2, r2, #12 blt 14f 13: mov r3, r7, lsr #16 ldr r7, [r1], #4 orr r3, r3, r7, lsl #16 str r3, [r0], #4 subs r2, r2, #4 bge 13b 14: sub r1, r1, #2 b 6b ;目标地址4字对齐，但源地址未4对齐：偏差为3（地址%4=3） 15: cmp r2, #12 ;考虑开头减去的4字节，实际是比较 ;处理字节数是否达到16字节，也就是4字， ;4字就是4个寄存器，下方stmia一次写4字 blt 17f sub r2, r2, #12 16: mov r3, r7, lsr #24 ldmia r1!,{r4 - r7} orr r3, r3, r4, lsl #8 mov r4, r4, lsr #24 orr r4, r4, r5, lsl #8 mov r5, r5, lsr #24 orr r5, r5, r6, lsl #8 mov r6, r6, lsr #24 orr r6, r6, r7, lsl #8 stmia r0!, {r3 - r6} subs r2, r2, #16 bge 16b adds r2, r2, #12 blt 18f ;目标地址4字对齐，但源地址未4对齐：偏差为3（地址%4=3）， ;且要拷贝字节数不到16字节，即不足4个寄存器 ;此时寄存r7存放的是首个字，因为偏差是3， ;所以高字节（大端情况下）是那个有效字节 ;其他3个字节是不用的，故下方使用了lsr#24 17: mov r3, r7, lsr #24 ;取出1个有效字节 ldr r7, [r1], #4 ;再取一字,r1+4 orr r3, r3, r7, lsl#8 ;从新字中去3字节与上方1字节合并成一个字 str r3, [r0], #4 ;写字 subs r2, r2, #4 ;如果r2剩余字节大于4则继续循环 bge 17b 18: sub r1, r1, #1 ;r1减1是因为最近一次载入的字中只有3个字节 ;被处理，还有一个字节是没有被处理的 b 6b ;扫尾 ;from 19: add r1, r1, r2 ;from结束地址 add r0, r0, r2 ;to结束地址 subs r2, r2, #4 blt 24f ands ip, r0, #3 bne 25f ands ip, r1, #3 bne 26f 20: subs r2, r2, #8 blt 23f subs r2, r2, #0x14 blt 22f 21: ldmdb r1!, {r3 - r9, ip} stmdb r0!, {r3 - r9, ip} subs r2, r2, #32 bge 21b 22: cmn r2, #16 ldmgedb r1!, {r3 - r6} stmgedb r0!, {r3 - r6} subge r2, r2, #16 adds r2, r2, #20 ldmgedb r1!, {r3 - r5} stmgedb r0!, {r3 - r5} subge r2, r2, #12 23: adds r2, r2, #8 blt 24f subs r2, r2, #4 ldrlt r3, [r1, #-4]! strlt r3, [r0, #-4]! ldmgedb r1!, {r3, r4} stmgedb r0!, {r3, r4} subge r2, r2, #4 24: adds r2, r2, #4 EXITEQ cmp r2, #2 ldrb r3, [r1, #-1]! strb r3, [r0, #-1]! ldrgeb r3, [r1, #-1]! strgeb r3, [r0, #-1]! ldrgtb r3, [r1, #-1]! strgtb r3, [r0, #-1]! EXIT 25: cmp ip, #2 ldrb r3, [r1, #-1]! strb r3, [r0, #-1]! ldrgeb r3, [r1, #-1]! strgeb r3, [r0, #-1]! ldrgtb r3, [r1, #-1]! strgtb r3, [r0, #-1]! subs r2, r2, ip blt 24b ands ip, r1, #3 beq 20b 26: bic r1, r1, #3 ldr r3, [r1], #0 cmp ip, #2 blt 34f beq 30f cmp r2, #12 blt 28f sub r2, r2, #12 27: mov r7, r3, lsl #8 ldmdb r1!, {r3, r4, r5, r6} orr r7, r7, r6, lsr #24 mov r6, r6, lsl #8 orr r6, r6, r5, lsr #24 mov r5, r5, lsl #8 orr r5, r5, r4, lsr #24 mov r4, r4, lsl #8 orr r4, r4, r3, lsr #24 stmdb r0!, {r4, r5, r6, r7} subs r2, r2, #16 bge 27b adds r2, r2, #12 blt 29f 28: mov ip, r3, lsl #8 ldr r3, [r1, #-4]! orr ip, ip, r3, lsr #24 str ip, [r0, #-4]! subs r2, r2, #4 bge 28b 29: add r1, r1, #3 b 24b 30: cmp r2, #12 blt 32f sub r2, r2, #12 31: mov r7, r3, lsl #16 ldmdb r1!, {r3, r4, r5, r6} orr r7, r7, r6, lsr #16 mov r6, r6, lsl #16 orr r6, r6, r5, lsr #16 mov r5, r5, lsl #16 orr r5, r5, r4, lsr #16 mov r4, r4, lsl #16 orr r4, r4, r3, lsr #16 stmdb r0!, {r4, r5, r6, r7} subs r2, r2, #16 bge 31b adds r2, r2, #12 blt 33f 32: mov ip, r3, lsl #16 ldr r3, [r1, #-4]! orr ip, ip, r3, lsr #16 str ip, [r0, #-4]! subs r2, r2, #4 bge 32b 33: add r1, r1, #2 b 24b 34: cmp r2, #12 blt 36f sub r2, r2, #12 35: mov r7, r3, lsl #24 ldmdb r1!, {r3, r4, r5, r6} 湖心亭看雪原文及翻译 湖心亭看雪 朝代：明代 作者：张岱 原文： 崇祯五年十二月，余住西湖。大雪三日，湖中人鸟声俱绝。是日 更定矣，余拏一小舟，拥毳衣炉火，独往湖心亭看雪。雾凇沆砀，天 与云与山与水，上下一白。湖上影子，惟长堤一痕、湖心亭一点、与 余舟一芥、舟中人两三粒而已。(余拏一作：余挐) 到亭上，有两人铺毡对坐，一童子烧酒炉正沸。见余，大喜曰：“湖中焉得更有此人？”拉余同饮。余强饮三大白而别。问其姓氏， 是金陵人，客此。及下船，舟子喃喃曰：“莫说相公痴，更有痴似相 公者！” 译文 崇祯五年（公元1632年）十二月，我住在西湖边。大雪接连下了 多天，湖中的行人、飞鸟的声音都消失了。这个天晚上八点左右，我 撑着一叶小舟，穿着毛皮衣，带着火炉，独自前往湖心亭看雪。（湖 面上）冰花一片弥漫，天和云和山和水，天光湖色全是白皑皑的。湖 上的影子，只有一道长堤的痕迹，一点湖心亭的轮廓，和我的一叶小舟，舟中的两三粒人影罢了。 到了湖心亭上，看见有两个人铺好毡子，相对而坐，一个小孩正 把酒炉（里的酒）烧得滚沸。（他们）看见我，非常高兴地说：“想 不到在湖中还会有您这样的人！”（他们）拉着我一同饮酒。我尽力 喝了三大杯酒，然后和他们道别。（我）问他们的姓氏，（得知他们）是南京人，在此地客居。等到了下船的时候，船夫喃喃地说：“不要 说相公您痴，还有像相公您一样痴的人啊！” 注释 1、崇祯五年：公元1632年。崇祯，是明思宗朱由检的年号（1628-1644）。 2、俱：都。 3、绝：消失。 4、是日更（gēng）定：是，代词，这。更定：指初更以后。晚上八点 左右。定，开始。 5、余：第一人称代词，我。 6、拏：通“桡”，撑（船）。 7、拥毳（cuì）衣炉火：穿着细毛皮衣，带着火炉。毳衣：细毛皮衣。毳：鸟兽的细毛。 8、雾凇沆砀：冰花一片弥漫。雾，从天上下罩湖面的云气。凇，从湖 面蒸发的水汽。沆砀，白气弥漫的样子。曾巩《冬夜即事诗》自注：“齐寒甚，夜气如雾，凝于水上，旦视如雪，日出飘满阶庭，齐人谓 之雾凇。 9、上下一白：上上下下全白。一白，全白。一，全或都，一概。 10、惟：只有。 11、长堤一痕：形容西湖长堤在雪中只隐隐露出一道痕迹。堤，沿河 或沿海的防水建筑物。这里指苏堤。一，数词。痕，痕迹。 12、一芥：一棵小草。芥，小草，比喻轻微纤细的事物；（像小草一 样微小）。 13、而已：罢了。 14、毡：毛毯。 C语言注释规范 1.注释原则 同一软件项目开发中，尽量保持代码注释规范和统一。 注释方便了代码的阅读和维护。 边写代码边注释，修改代码时要相应修改注释，保证注释和代码的一致性。 注释要简洁明确，不要出现形容词。 对于写的好的注释，我们将是第一个受益者。 大型软件开发中，通过别人的注释可以快速知道他人所写函数的功能，返回值，参数的使用。 2.文件头部的注释 示例： / * Program Assignment : 该文件的作用 * Author: 作者 * Date: 2013/8/6 14:34 * Description: 该文件的描述 *****/ /* * Source code in : 源代码的路径 * Function List: * initLinear 初始化线性表 * destoryLinear 释放线性表申请的空间 * isLinearEmpty 判断线性表是否为空 * isLinearFull 判断线性表是否为满 * getLinearElementValue 取得下标为index的元素的值 */ 注意：这个函数列表可以快速查询到我们想要了解的函数。 3.结构体，全局变量等的注释 示例： typedef POLYNOMIAL USER_TYPE; /* 新的数据类型的描述*/ int a; /* 全局变量的作用*/ /* 说明结构体的功能*/ typedef struct LINEAR { USER_TYPE *data; /* 每个成员的意义(作用) */ int maxRoom; /* 每个成员的意义(作用) */ int elementCount; /* 每个成员的意义(作用) */ }LINEAR; 4.函数的注释 在逻辑性较强的的地方加入注释，以便其他人的理解，在一定的程度上排除bug。 示例： /* * Function Name: getLinearElementIndex * Purpose: 取得元素的index值 * Params : * @LINEAR linear 线性表实例 * @USER_TYPE var 类型为USER_TYPE的实例 * @int (*)() cmp 提供接口，让用户定义具体比较函数 * Return: int 返回元素的index值 * Limitation: 如果返回-1，则代表不存在var的元素 */ int getLinearElementIndex(LINEAR linear, USER_TYPE var, int (*cmp)()) { /* * 如果逻辑太过复杂，这里写明该算法的过程和思路。 */ boolean found = FALSE; int i; for(i = 0; i < && !found; i++) if(cmp[i], var) == 0) found = TRUE; if(i >= i = NOT_FOUND; return i; } 湖心亭看雪 ——张岱 崇祯五年②十二月，余住西湖。大雪三日，湖中人鸟声俱绝。是日更定③，余拏④一小船，拥毳衣炉火⑤，独往湖心亭看雪。雾凇沆砀⑥，天与云与山与水，上下一白⑦。湖上影子，惟长堤一痕⑧,湖心亭一点,与余舟一芥,舟中人两三粒而已。 到亭上，有两人铺毡对坐，一童子烧酒炉正沸。见余，大喜曰：“湖中焉得更有此人⑨！”拉余同饮。余强⑩饮三大白而别，问其姓氏，是金陵人，客此。及下船，舟子喃喃曰：“莫说相公痴，更有痴似相公者！” 注释： 1.本文选自《陶庵梦忆》张岱(1597-1679），字宗子，又字石公，号陶庵，又号蝶庵居士，明末清初山阴（浙江绍兴）人。原居杭州。出身仕宦世家，少时为富贵公子，爱繁华，好山水，晓音乐、戏曲，明亡后不仕，入山著书以终。著有《陶庵梦忆》《西湖梦寻》《琅嬛文集》《三不朽图赞》《夜航船》《白洋潮》等绝代文学名著。 2.【崇祯五年】公元1632年。崇祯，明思宗朱由检年号（1628-1644）。 3.【是日更(gēng)定】是：代词，这。更定：指初更以后,晚上八点左右.更，古代夜间计时，一夜分为五更，每更大约两小时。定，开始。 4.【余】我 5.【拏(ná)】即“拿”，持，引申为撑，划，牵引，撑（船）。 6.【拥毳〔cuì〕衣炉火】穿着细毛皮衣，带着火炉乘船。毳衣，细毛皮衣。毳，鸟兽的细毛。 7.【雾凇沆砀(hàng dàng)】雪夜寒气弥漫。雾凇，云、水气；雾，是从天空下罩湖面的云气，凇，是从湖面上蒸发的水汽，这时因为天寒，凝成冰花。曾巩《冬夜即事诗》自注：“齐寒甚，夜气如雾，凝于水上，旦视如雪，日出飘满阶庭，齐人谓之雾凇。”沆砀：白气弥漫的样子。沆，形容大水。 程序代码注释编写规范 为提高控制程序的阅读性与可理解性，现制定相关代码程序代码注释编写的编写规范。 一般情况下，源程序有效注释量必须在20％以上，注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。 常规注释有以下两种方式。 单行:以"//"符号开始，任何位于该符号之后的本行文字都视为注释。 多行:以"/*"符号开始，以"*/"结束。任何介于这对符号之间的文字都视为注释。 一、说明性文件 说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。 示例：下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。 /************************************************* COPYRIGHT (C), MicTiVo International. Co., Ltd. File NAME: // 文件 Author: Version: Date: // 作者、版本及完成日期 DESCRIPTION: // 用于详细说明此程序文件完成的主要功能，与其他模块 // 或函数的接口，输出值、取值范围、含义及参数间的控 // 制、顺序、独立或依赖等关系 Others: // 其它内容的说明 Function List: // 主要函数列表，每条记录应包括函数名及功能简要说明 1.... History: // 修改历史记录列表，每条修改记录应包括修改日期、修改 // 者及修改内容简述 1. Date: Author: Modification: 2. .. *************************************************/ 二、源文件头 源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。 示例：下面这段源文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。 /************************************************************ COPYRIGHT (C), MicTiVo International. Co., Ltd. FileName: Author: 《湖心亭看雪》全文翻译及注释 崇祯五年②十二月，余住西湖。大雪三日，湖中人鸟声俱绝。是日更定③矣，余挐④一小舟，拥毳衣炉火⑤，独往湖心亭看雪。雾凇沆砀⑥，天与云与山与水，上下一白⑦。湖上影子，惟长堤一痕⑧，湖心亭一点，与余舟一芥，舟中人两三粒而已。 到亭上，有两人铺毡对坐，一童子烧酒炉正沸。见余，大喜曰：“湖中焉得更有此人！⑨”拉余同饮。余强饮三大白⑩而别，问其姓氏，是金陵人，客此⑩①。及下船，舟子⑩②喃喃⑩③曰：“莫说相公⑩④痴，更⑩⑤有痴⑩⑥似相公者。” ②崇祯五年：公元1632年。崇祯，明思宗朱由检年号（1628-1644）。 ③更定：指初更以后，晚上8点左右。更：旧时一夜分为五更，每更的大约2小时。 ④挐：通“桡”，撑（船），划（船）。一作“拏”。 ⑤拥毳衣炉火：穿着皮毛衣，带着火炉乘船。毳衣，用皮毛制成的衣服。毳，鸟兽的细毛。 ⑥雾凇沆砀：形容雪夜寒气弥漫。雾凇，云、水气；雾是从天空下罩湖面的云气，凇是从湖面上蒸发的水汽，雾凇，水汽凝成的冰花。曾巩《冬夜即事诗》自注：“齐寒甚，夜气如雾，凝于水上，旦视如雪，日出飘满阶庭，齐人谓之雾凇。”沆砀，白气弥漫的样子。沆，形容大水 ⑦一白：全白。 ⑧长堤一痕：形容西湖长堤在雪中只隐隐露出一道痕迹。堤，沿河或沿海的防水建筑物。 ⑨焉得更有此人：意思是想不到还会有这样的人。焉得，哪能。更、还。 ⑩白：古人罚酒时用的酒杯，这里指小白玉酒杯。 ⑩①客此：在此地客居。 崇祯五年十二月，我居住在西湖湖畔。连下了几天的大雪，湖中游人、飞鸟的声音完全消失了。这一天初更以后（大约八点以后），我撑着一只小船，穿着毛皮衣，带着火炉，独自前往湖心亭欣赏雪景。冰花一片弥漫，天空、云朵、远处的山峰和湖水，上下一片白色。湖面上倒映着的影子，只有(隐约的)一道长堤的痕迹，一点湖心亭的轮廓，和我的一叶小舟，以及舟中的两三个人影罢了。到了湖心亭上，有两个人铺着毡席，相对而坐，一个小书童正在烧酒，酒炉中的水正在沸腾（古时喝烧酒前要烧，烧酒时，把水放在火上烧，然后再把酒放在水中,)。（那两个人）看见我，十分惊喜地说：“想不到在湖中还能遇见像你这样（有闲情雅致）的人。”便拉着我一同喝酒。我尽力喝了三大杯告别。（我）问他们的姓氏，得知他们是金陵人，在此地客居。等到下船的时候，船夫喃喃地说：“不要说相公（古代旧时对士人的尊称）痴迷，还有比相公您更痴迷的人呢!” 《湖心亭看雪》是明末清初文学家张岱创作的一篇散文。以下是分享的湖心亭看雪湖心亭看雪原文及翻译，希望能帮助到大家! 湖心亭看雪湖心亭看雪原文及翻译 湖心亭看雪 明代张岱 崇祯五年十二月，余住西湖。大雪三日，湖中人鸟声俱绝。是日更定矣，余拏一小舟，拥毳衣炉火，独往湖心亭看雪。雾凇沆砀，天与云与山与水，上下一白。湖上影子，惟长堤一痕、湖心亭一点、与余舟一芥、舟中人两三粒而已。(余拏一作余挐) 到亭上，有两人铺毡对坐，一童子烧酒炉正沸。见余大喜曰“湖中焉得更有此人!”拉余同饮。余强饮三大白而别。问其姓氏，是金陵人，客此。及下船，舟子喃喃曰“莫说相公痴，更有痴似相公者。” 译文及注释 译文 崇祯五年十二月，我住在西湖边。大雪接连下了多日，湖中游人全无，连飞鸟的声音都消失了。这天初更时分，我撑着一叶小舟，穿着细毛皮衣，带着火炉，独自前往湖心亭看雪。湖面上冰花一片弥漫，天与云与山与水，浑然一体，白茫茫一片。湖上的影子，只有一道长堤的痕迹，一点湖心亭的轮廓，和我的一叶小舟，舟中的两三粒人影罢了。 到了湖心亭上，看见有两人铺好毡子，相对而坐，一个童子正把酒炉里的酒烧得滚沸。他们看见我，非常高兴地说“想不到在湖中还会有您这样有闲情逸致的人!”于是拉着我一同饮酒。我尽力喝了三大杯酒，然后和他们道别。问他们的姓氏，得知他们是金陵人，在此地客居。等到了下船的时候，船夫喃喃地说“不要说相公您痴，还有像相公您一样痴的人啊!” 注释 崇祯五年公元1632年。崇祯，是明思宗朱由检的年号(1628-1644)。 俱都。 绝消失。 是日更(gēng)定是，代词，这。更定指初更以后。晚上八点左右。定停止，结束。 余第一人称代词，我。 程序代码注释编写规范 XXX份公司 为提高控制程序的阅读性与可理解性，现制定相关代码程序代码注释编写的编写规范。 一般情况下，源程序有效注释量必须在20％以上，注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。 常规注释有以下两种方式。 单行:以"//"符号开始，任何位于该符号之后的本行文字都视为注释。 多行:以"/*"符号开始，以"*/"结束。任何介于这对符号之间的文字都视为注释。 一、说明性文件 说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。 示例：下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。 /************************************************* COPYRIGHT (C), MicTiVo International. Co., Ltd. File NAME: // 文件 Author: Version: Date: // 作者、版本及完成日期 DESCRIPTION: // 用于详细说明此程序文件完成的主要功能，与其他模块 // 或函数的接口，输出值、取值范围、含义及参数间的控 // 制、顺序、独立或依赖等关系 Others: // 其它内容的说明 Function List: // 主要函数列表，每条记录应包括函数名及功能简要说明 1.... History: // 修改历史记录列表，每条修改记录应包括修改日期、修改 // 者及修改内容简述 1. Date: Author: Modification: 2. .. *************************************************/ 二、源文件头 源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。 示例：下面这段源文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。 /************************************************************ 《湖心亭看雪》知识点 一、原文、译文 崇祯五年十二月，余住西湖。大雪三日，湖中人鸟声俱绝。是日更定矣，余(注意课本中书写，拼音打不出来)一小舟，拥毳衣炉火，独往湖心亭看雪。雾凇沆砀，天与云与山与水，上下一白。湖上影子，惟长堤一痕、湖心亭一点、与余舟一芥、舟中人两三粒而已。 到亭上，有两人铺毡对坐，一童子烧酒炉正沸。见余，大喜曰：“湖中焉得更有此人!”拉余同饮。余强饮三大白而别。问其姓氏，是金陵人，客此。及下船，舟子喃喃曰：“莫说相公痴，更有痴似相公者! 【译文】译文：崇祯五年十二月，我住在西湖。接连下了三天的大雪，湖中行人、飞鸟的声音都消失了。这一天凌晨时，我划着一只小船，穿着毛皮衣服、带着火炉，一个人去湖心亭欣赏雪景。(湖上)弥漫着水气凝成的冰花，天与云与山与水，浑然一体，白茫茫一片。湖上能见到的影子，只有(淡淡的)一道长堤的痕迹，一点湖心亭的轮廓，和我的一叶小舟，舟中的两三粒人影罢了。 到了亭子上，看见有两个人已铺好了毡子，相对而坐，一个童子正把酒炉里的酒烧得滚沸。那两个人看见我，非常高兴地说：“在湖中怎么还能碰上(您)这样(有闲情雅致)的人呢!”拉着我一同喝酒。我痛饮了三大杯，然后(和他们) 道别。问他们的姓氏，得知他们是金陵人，在此地客居。等到(回来时)下了船，船夫嘟哝道：“不要说相公您痴，还有像您一样痴的人呢!” 二、文学常识积累 《湖心亭看雪》选自《陶庵梦忆》。作者张岱，字宗子，又字石公，号陶庵，又号蝶庵居士，明末清初(朝代)山阴(籍贯)人。出身世家，少为富贵公子，爱繁华，好山水，晓音乐、戏曲，明亡后不仕，入山著书以终。有《陶庵梦忆》《西湖梦寻》等。 相关背景 他出身仕宦家庭，早岁生活优裕，晚年避居山中，穷愁潦倒坚持著述。一生落拓不羁，淡泊功名，具有广泛的爱好和审美情趣。他喜游历山水，深谙园林布置之法;懂音乐，能弹琴制曲;善品茗，茶道功夫颇深;好收藏，具备非凡的鉴赏水平;精戏曲，编导评论追求至善至美。前人说：‘吾越有明一代，才人称徐文长、张陶庵，徐以奇警胜，先生以雄浑胜。 张岱继“公安”“竟陵”两派之后，以清淡天真之笔，写国破家亡之痛，寓情于境，意趣深远，算得上晚明散文作家中一位成就较高的“殿军”。他的小品可谓名副其实的小品，长者不过千把字，短者仅一二百字，笔墨精练，风神绰约，洋溢着诗的意趣。人们常说散文贵有诗意，这是很对的。 1、头文件包含Includes 2、私有类型定义 Private typedef 3、私有定义Private define 4、私有宏定义 Private macro 5、私有变量 Private variables 6、私有函数原型Private function prototypes 7、私有函数Private functions 8、私有函数前注释 /****************************************************************************** * * Function Name : FSMC_NOR_Init * Description : Configures the FSMC and GPIOs to interface with the NOR memory. * This function must be called before any write/read operation * on the NOR. * Input : None * Output : None * Return : None ******************************************************************************* / 9、程序块采用缩进风格编写，缩进空格为4。 10、相对独立的程序块之间、变量说明之后必须加空行； 11、较长的字符（>80字符）要分成多行书写，长表达式要在低优先级操作符划分新行，操作符放在新行之首，新行要恰当缩进，保持排版整齐； 12、循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首; 13、若函数或过程中的参数较长，则要进行适当的划分。 14、不允许把多个短语句写在一行中，即一行只写一条语句。 15、if、for、do、while、case、switch、default等语句自占一行，且if、for、 do、while等语句的执行语句部分无论多少都要加括号{}。 16、对齐只使用空格键，不使用TAB键； 17、 函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，case 语句下的情况处理语句也要遵从语句缩进要求 18、 程序块的分界符（如C/C++语言的大括号‘{’和‘}’）应各独占一行并且位于同一 列，同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以 及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。 19、 在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或 湖心亭看雪字词批注译文及知识点完全归纳 崇祯五年十二月，余住西湖。大雪三日，湖中人鸟声俱绝。 是日更定矣，余拏一小舟，拥毳衣炉火，独往湖心亭看雪。 雾凇沆砀，天与云与山与水，上下一白。 湖上影子，惟长堤一痕、湖心亭一点、与余舟一芥、舟中人两三粒而已。 到亭上，有两人铺毡对坐，一童子烧酒炉正沸。 见余，大喜曰：“湖中焉得更有此人！”拉余同饮。 余强饮三大白而别。问其姓氏，是金陵人，客此。 及下船，舟子喃喃曰：“莫说相公痴，更有痴似相公者！” 译文 崇祯五年（公元1632年）十二月，我住在西湖边。 大雪接连下了多天，湖中的行人、飞鸟的声音都消失了。 这一天晚上八点左右，我撑着一叶小舟， 穿着毛皮衣，带着火炉，独自前往湖心亭看雪。 （湖面上）冰花一片弥漫，天和云和山和水，天光湖色全是白皑皑的。 湖上的影子，只有一道长堤的痕迹， 一点湖心亭的轮廓，和我的一叶小舟，舟中的两三粒人影罢了。 到了湖心亭上，看见有两个人铺好毡子，相对而坐，一个小孩正把酒炉（里的酒）烧得滚沸。（他们）看见我，非常高兴地说：“想不到在湖中还会有您这样的人！” （他们）拉着我一同饮酒。我尽情的喝了三大杯酒，然后和他们道别。 （我）问他们的姓氏，（得知他们）是南京人，在此地客居。 等到了下船的时候，船夫喃喃地说：“不要说相公您痴，还有像相公您一样痴的人啊！” 一、【重点注释】 1、是日更定矣是:这。 定:完了,结束 2、余挐一小船,拥毳衣炉火。 挐:通“桡”,撑,划。毳衣:用毛皮制成的衣服。 3、雾淞沆砀。 沆砀:白气弥漫的样子 4、湖中焉得更有此人焉: 哪里。更:还 5、余强饮三大白而别 强:勉强。白:指酒杯 6、上下一白 一白:全白 7、客此。及下船 客此:在此地客居;及:等到 8、相公: 旧时对士人的尊称。 二、词类活用 1.大雪三日大雪：名词活用作动词，下大雪。 程序注释规范说明 程序注释规范应包括以下三方面： 一、文件头部注释 在代码文件的头部进行注释，这样做的好处在于，我们能对代码文件做变更跟踪。在代码头部分标注出创始人、创始时间、修改人、修改时间、代码的功能，这在团队开发中必不可少，它们可以使后来维护/修改的同伴在遇到问题时，在第一时间知道他应该向谁去寻求帮助，并且知道这个文件经历了多少次迭代、经历了多少个程序员的开发和修改。 样本： /***************************************************** ** 作者：Liuchao ** 创始时间：2007-11-12 ** 修改人：Liuchao ** 修改时间：2007-11-12 ** 修改人：Liaochao ** 修改时间：2007-11-12 ** 描述： ** 主要用于产品信息的资料录入，… *****************************************************/ 二、函数、属性、类等注释 请使用///三斜线注释，这种注释是基于XML的，不仅能导出XML制作帮助文档，而且在各个函数、属性、类等的使用中，编辑环境会自动带出注释，方便你的开发。以protected，protected Internal，public声明的定义注释都建议以这样命名方法。 例如： /// /// 用于从ERP系统中捞出产品信息的类 /// class ProductTypeCollector { … } 三、逻辑点注释 在我们认为逻辑性较强的地方加入注释，说明这段程序的逻辑是怎样的，以方便我们自己后来的理解以及其他人的理解，并且这样还可以在一定程度上排除BUG。在注释中写明我们的逻辑思想，对照程序，判断程序是否符合我们的初衷，如果不是，则我们应该仔细思考耀修改的是注释还是程序了… 四、变量注释 我们在认为重要的变量后加以注释，说明变量的含义，以方便我们自己后来的理解以及其他人的理解，并且这样还可以在一定程度上排除BUG.我们常用///三斜线注释。 /// 用于从ERP系统中捞出产品信息的类 class ProductTypeCollector { int STData;/// 部编版九年级上全册古文精品习题及答案 题型：【重点注释默写】【文言现象：通假字、古今异义、词类活用、一词多义、文言句式】【重点句子翻译】【课外文言文阅读】 目录： 第10课《岳阳楼记》检测题 第11课《醉翁亭记》检测题 第12课《湖心亭看雪》检测题 第10课《岳阳楼记》检测题 班级：姓名： 一、重点课下注释默写： 晖，。 11、【大观】。 12、【前人之述备矣】 。 13、【然则】。 14、【南极潇湘】。 极，。 15、【迁客】。 迁，。 16、【骚人】。 17、【览物之情，得无异乎】 ？ 得无，。 36、【浮光跃金】。 37、【静影沉璧】。 璧，。 38、【何极】。 39、【宠辱偕忘】。 宠，。偕，。 40、【把酒临风】。 把，。 41、【求】。 42、【古仁人】。 43、【或异二者之为】 。或，。44、【不以物喜，不以己悲】 。 45、【居庙堂之高】 。庙堂，。 46、【处江制之远】 。47、【其必日“先天下之忧而忧，后天下之乐而乐”乎】 。先，。后，。 48、【微斯人，吾谁与归】 ?微，。 二、文言知识积累： 1、分析下列加点字的用法并解释： ①属．予作文以记之： ②百废具．兴： ③越．明年，政通人和： ④增其旧制．： ⑤薄．暮冥冥： ⑥气象 ．．万千： ⑦微．斯人： ⑧此则岳阳楼之大观．也： ⑨横．无际涯： ⑩予观夫．巴陵胜状： ?前人之述备．矣： ?嘱予作文 ．．以记之： ?则有去国．怀乡： ?则有去．国怀乡： ?予尝．求古仁人之心： ?宠．辱偕忘： ?沙鸥翔集．： ?春和景．明： ?进．亦忧，退亦忧： ?先．天下之忧而忧： ?后．天下之乐而乐： ?忧谗．畏讥： ?刻唐贤．今人诗赋于其上： ?而或长烟一空．： 湖心亭看雪原文及译文集团公司文件内部编码：（TTT-UUTT-MMYB-URTTY-ITTLTY- 湖心亭看雪 张岱·明末清初 崇祯五年十二月，余住西湖。大雪三日，湖中人鸟声俱绝。是日更(ɡēnɡ)定矣，余挐(ráo 人教版上标注为nú，另有作拏ná)一小舟，拥毳(cuì)衣炉火，独往湖心亭看雪。雾凇(sōnɡ)沆(hànɡ)砀(dànɡ)，天与云与山与水，上下一白。湖上影子，惟长堤一痕、湖心亭一点、与余舟一芥(jiè)、舟中人两三粒而已。 到亭上，有两人铺毡(zhān)对坐，一童子烧酒炉正沸。见余，大喜曰：“湖中焉得更有此人！”拉余同饮。余强(qiǎnɡ)饮三大白而别。问其姓氏，是金陵人，客此。及下船，舟子喃喃曰：“莫说相公痴，更(ɡènɡ)有痴似相公者！” 【译文】： 崇祯五年十二月，我客居在(杭州)西湖。下了三天的雪，湖中人、鸟的声音全都消失了。这一天初更以后(晚上大约八点)，我划着一只小船，穿着毛皮衣，带着火炉，准备一个人去湖心亭欣赏雪景。雪夜寒气弥漫，天与云与山与水，浑然一体，白茫茫一片。湖上能(清晰)见到的影子，只有(淡淡的)一道长堤的痕迹(苏堤)，一点湖心亭的轮廓，和我的一叶小船，船上两三个人罢了。 到了湖心亭上，(我看见)有两个人铺着毡席，相对而坐，一个小书童正在烧酒，酒炉中的酒正在沸腾。(那两个人)看见我，十分惊喜的说：“想不到在湖中还能遇见你这样有(闲情雅致)的人。”便拉着我一同喝酒。我尽力喝了三大杯酒后就告别。我问他们的姓名，(他们回答)说他们是金陵人，在此地客居。等我下船的时候，船夫喃喃自语地说：“不要说相公痴迷，还有和相公一样痴迷的人呢!” 在软件开发的过程中总是强调注释的规范，但是没有一个具体的标准进行说明，通常都是在代码编写规范中简单的描述几句，不能作为一个代码注释检查的标准和依据，做什么都要有一个依据吗:),现在我特整理了一个《Java的注释规范》，内容来自网络、书籍和自己的实际积累。 JA V A注释规范 版本/状态作者版本日期 1.0 ghc 2008-07-02 一、背景 1、当我们第一次接触某段代码，但又被要求在极短的时间内有效地分析这段代码，我们需要什么样的注释信息？ 2、怎么样避免我们的注释冗长而且凌乱不堪呢？ 3、在多人协同开发、维护的今天，我们需要怎么样的注释来保证高质、高交的进行开发和维护工作呢？ 二、意义 程序中的注释是程序设计者与程序阅读者之间通信的重要手段。应用注释规范对于软件本身和软件开发人员而言尤为重要。并且在流行的敏捷开发思想中已经提出了将注释转为代码的概念。好的注释规范可以尽可能的减少一个软件的维护成本, 并且几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护。好的注释规范可以改善软件的可读性，可以让开发人员尽快而彻底地理解新的代码。好的注释规范可以最大限度的提高团队开发的合作效率。长期的规范性编码还可以让开发人员养成良好的编码习惯，甚至锻炼出更加严谨的思维能力。 三、注释的原则 1、注释形式统一 在整个应用程序中，使用具有一致的标点和结构的样式来构造注释。如果在其他项目组发现他们的注释规范与这份文档不同，按照他们的规范写代码，不要试图在既成的规范系统中引入新的规范。 2、注释的简洁 内容要简单、明了、含义准确，防止注释的多义性，错误的注释不但无益反而有害。 3、注释的一致性 在写代码之前或者边写代码边写注释，因为以后很可能没有时间来这样做。另外，如果有机会复查已编写的代码，在今天看来很明显的东西六周以后或许就不明显了。通常描述性注释先于代码创建，解释性注释在开发过程中创建，提示性注释在代码完成之后创建。修改代码的同时修改相应的注释，以保证代码与注释的同步。 4、注释的位置 保证注释与其描述的代码相邻，即注释的就近原则。对代码的注释应放在其上方相邻或右方的位置，不可放在下方。避免在代码行的末尾添加注释；行尾注释使代码更难阅读。不过在批注变量声明时，行尾注释是合适的；在这种情况下，将所有行尾注释要对齐。 5、注释的数量 注释必不可少，但也不应过多，在实际的代码规范中，要求注释占程序代码的比例达到20%左右。注释是对代码的“提示”，而不是文档，程序中的注释不可喧宾夺主，注释太多了会让人眼花缭乱，注释的花样要少。不要被动的为写注释而写注释。 6、删除无用注释 湖心亭看雪 一、情境导入： 与同学们聊一聊，今年第一场雪给你带来了哪些快乐？ 是呀，世上好像没有一种快乐，比初雪更叫人雀跃。你若不曾在厢房里等雪，你就不懂“忽如一夜春风来，千树万树梨花开”的喜悦；你若不曾在雪地里独坐，你就不懂“孤舟蓑笠翁，独钓寒江雪”的自在；你若不曾在冬夜里归来，你就不懂“柴门闻犬吠，风雪夜归人”的温暖。 这节课，就让我们去品读雪夜下张岱的西湖情怀。 板书：题目、作者 二、明确任务： 这节课我们的任务是： 1.感知课文，积累文言词句。 2.品味语言，欣赏西湖雪景。 3.走近作者，感悟文人情思。 三、自主预习生成：诵读 读的要求： 字正腔圆——读准字音。 入情入味——读出节奏。 字斟句酌——读懂文意。 1.共同识记黑板上同学提醒的需要注意的字（毳挐）。下面请大家大声自由朗读课文，注意：读准字音，把握节奏（屏显）（学生自由朗读课文） 2.老师范读课文。 3.学生齐读课文，做到声音响亮，读准字音，读出节奏。 四、走组互助形成：译读 1、小组合作疏通文意。 请同学们结合注释，先自主通译全文。有疑问的地方在组内和组间解决，小组内不能解决的疑难字词提出来，全班一起解决。 2、学生质疑问难。师生合作解决。 学生问题：“与余舟一芥”的“芥”，“更有痴似相公者”的“痴”等字的解释。 “是日”的“是”字含义。 “强饮三大白”中“强”的读音。 3、检测题（屏显） 重点词语： （1）及下船联系旧知学习新知：《桃花源记》“及郡下”《孙权劝学》 “及鲁肃过寻阳”，两句中的“及”都是等到的“意思”。 (2)是金陵人，客此客居，名词作动词 一词多义： 一：上下一白长堤一痕 更：是日更定更有痴似相公者 是：是日更定问其姓氏，是金陵人 绝：人鸟声俱绝与妻子邑人来此绝境 白：上下一白余强饮三大白 翻译句子，师生共同交流，注意句子中的关键词，明确答案。 重点句子翻译： (1)莫说相公痴，更有痴似相公者！（倒装句） （2）湖上影子，惟长堤一痕、湖心亭一点、与余舟一芥、舟中人两三粒而已。 带着对内容的理解，再读课文，找两个同学，一人一段范读，学生评价朗读情况。过渡：内容与情感是相辅相成的，下面就来欣赏西湖奇美的雪景和张岱的雅趣。 五、展示质疑合成：品读 张岱在《<西湖梦寻>自序》中写道：余生不辰,阔别西湖二十八载,然西湖无日不入吾梦中,而梦中之西湖,实未尝一日别余也。 曾自名为“西湖知己”的张岱曾说过，他是这位西子眼里唯一的情人。 1.文中最能体现张岱和西湖的亲密关系的是哪一个字？ 预设：学生能很容易找到“痴”字。 2.他的“痴”表现在哪些方面？找出文中相应的句子，并谈谈你的体会。 学生回答：“大雪三日，湖中人鸟声俱绝。”“是日更定③，余拏④一小船，拥毳衣炉火⑤，独往湖心亭看雪”。着重分析“人鸟声俱绝”（没有声音，没有任何生命体活动的环境下去赏雪。）“是日更定”（时间特殊）。“拥”看出天气寒冷 3.痴迷于西湖雪景： 雾凇沆砀，天与云与山与水，上下一白。湖上影子，惟长堤一痕、湖心亭一点、与余舟一芥、舟中人两三粒而已。 品赏雪景。（温馨提示：可以从句子中富有表现力的词语、描写景物的特点、写景的手法等方面来赏析。） 生：①“一白”，按照由上到下的顺序写出了天、云、山、水的浑然一体，苍茫而又辽阔的世界，冰莹洁白，银装素裹。 ②天、云、山、水形体上阔大，与堤、亭、舟、人的渺小，形成了鲜明的对比，此景之下，形体最为微小的人融进这广袤的自然，与自然和谐统一，沧海一粟的感觉油然而生，产生“天人合一”的庄重感……（带着对浩淼、苍茫的西湖雪景的赞美朗读这句话） ③关于写法白描，白描：语言简练朴素，不重华丽的辞藻修辞和烘托渲染。结合这个写景的句子，再举一例。 小结：300多年前的西湖雪景仿佛正穿越时空的千山万壑向我们走来。这也体现了作者张岱超凡脱俗的行为方式，和天人合一的感慨。 4.学生质疑：“独往湖心亭看下文的”“两三粒”人影矛盾吗？结合文中语句辨析。 ①“莫说相公痴，更有痴似相公者”和舟子说话的神态“喃喃”体会舟子 代码编写规范说明书（c#.net与https://www.360docs.net/doc/f210752321.html,）目录 1 目的 2 范围 3 注释规范 3.1 概述 3.2 自建代码文件注释 3.3 模块（类）注释 3.4 类属性注释 3.5 方法注释 3.6 代码间注释 4 命名总体规则 5 命名规范 5.1 变量（Variable）命名 5.2 常量命名 5.3 类（Class）命名 5.4 接口（Interface）命名 5.5 方法（Method）命名 5.6 名称空间Namespace）命名 6 编码规则 6.1 错误检查规则 6.2 大括号规则 6.3 缩进规则 6.4 小括号规则 6.5 If Then Else规则 6.6 比较规则 6.7 Case规则 6.8 对齐规则 6.9 单语句规则 6.10 单一功能规则 6.11 简单功能规则 6.12 明确条件规则 6.13 选用FALSE规则 6.14 独立赋值规则 6.15 定义常量规则 6.16 模块化规则 6.17 交流规则 7 编程准则 7.1 变量使用 7.2 数据库操作 7.3 对象使用 7.4 模块设计原则 7.5 结构化要求 7.6 函数返回值原则 8 代码包规范 8.1 代码包的版本号 8.2 代码包的标识 9 代码的控制 9.1 代码库/目录的建立 9.2 代码归档 10 输入控制校验规则 10.1 登陆控制 10.2 数据录入控制 附件1：数据类型缩写表 附件2：服务器控件名缩写表 1 目的 一.为了统一公司软件开发设计过程的编程规范 二.使网站开发人员能很方便的理解每个目录,变量，控件，类，方法的意义 三.为了保证编写出的程序都符合相同的规范，保证一致性、统一性而建立的程序编码规范。 四.编码规范和约定必须能明显改善代码可读性，并有助于代码管理、分类范围适用于企业所有基于.NET平台的软件开发工作 2 范围 本规范适用于开发组全体人员，作用于软件项目开发的代码编写阶段和后期维护阶段。 3 注释规范 3.1 概述 a) 注释要求英文及英文的标点符号。 b) 注释中，应标明对象的完整的名称及其用途，但应避免对代码过于详细的描述。 c) 每行注释的最大长度为100个字符。 d) 将注释与注释分隔符用一个空格分开。 e) 不允许给注释加外框。 f) 编码的同时书写注释。 g) 重要变量必须有注释。 h) 变量注释和变量在同一行，所有注释必须对齐，与变量分开至少四个“空格”键。 如：int m_iLevel,m_iCount; // m_iLevel ....tree level // m_iCount ....count of tree items string m_strSql; //SQL i) 典型算法必须有注释。 j) 在循环和逻辑分支地方的上行必须就近书写注释。 k) 程序段或语句的注释在程序段或语句的上一行 l) 在代码交付之前，必须删掉临时的或无关的注释。 m) 为便于阅读代码，每行代码的长度应少于100个字符。 3.2 自建代码文件注释 对于自己创建的代码文件（如函数、脚本），在文件开头，一般编写如下注释： /****************************************************** FileName: Copyright (c) 2004-xxxx *********公司技术开发部 Writer: create Date: Rewriter: 湖心亭看雪的原文和翻译 《湖心亭看雪 》以精炼的笔墨，记叙了作者自己湖心亭看雪的经过，描绘了所看到的幽静 深远、洁白广阔的雪景图，表达他幽远脱俗的闲情雅致。下面是小编为大家整理 了湖心亭看雪原文和翻译，希望能帮到大家！ 湖心亭看雪 明·张岱 【原文】 崇祯五年十二月，余住西湖。大雪三日，湖中人鸟声俱绝。是日更定，余拿 一小舟， 拥毳衣炉火， 独往湖心亭看雪。 雾凇沆砀， 天与云与山与水， 上下一白。 湖上影子， 惟长堤一痕、 湖心亭一点、 与余舟一芥、 舟中人两三粒而已。 到亭上， 有两人铺毡对坐，一童子烧酒炉正沸。见余，大喜曰：“湖中焉得更有此人!” 拉余同饮。余强饮三大白而别。问其姓氏，是金陵人，客此。及下船，舟子喃喃 曰：“莫说相公痴，更有痴似相公者!” 【译文】 崇祯五年十二月，我在杭州西湖。下了三天大雪，湖中游人全无，连鸟声也 都听不见了。这一天天刚刚亮，我划着一只小船，穿着皮袍，带着火炉，一个人 去湖心亭欣赏雪景。树挂晶莹，白气弥漫，天、云、山、水，上一上一下一下一 片雪白。湖上能见到的影子，只有西湖长堤一道淡淡的痕迹，湖心亭是一片白中 的一点，和我的船像一片漂在湖中的草叶，船上的人像两三粒小小的芥子，唯此 而已。 到了湖心亭上， 已经有两个人铺着毡席， 对坐在那儿， 一个小仆人烧着酒炉， 炉上的酒正在沸腾。那两个人看见我，十分惊喜地说：“湖中哪能还有这样赏雪 的痴情一人！”拉着我一同喝酒。我勉强喝了三大杯就告别。问他们的姓名，原 是金陵人在此地作客。 我走上自己船的时候， 替一我驾船的人喃喃自语地说： “不 要说先生痴，还有像你一样痴的人。” 【作者】 张岱(1597—1679)字宗子，又字石公，号陶庵，山－阴－(今浙江绍兴)人。 侨寓杭州。其家自曾祖以来，均为显宦。他早年过着精舍骏马，鲜衣美食，斗鸡 放鹰，弹琴吟诗的贵公子生活。喜游山水，通晓音乐戏剧，一生未曾仕宦。明亡 Comments criterion of the Code 在多个PROJIECT共同开发的前提下，为了减少修改升级CODE过程中出现失误和方便SI 人员对代码的维护，加强部门整体代码注释规范，建议通过在每一次代码修改过程中添加代码标志符进行注释，这样可以使软件工程师在升级代码的过程中减少错误率，同时可以保持对以前版本代码的修改思路清晰，能在最短时间里复查代码中的错误。 标准C++/C的文件结构： // Copyright (c) Microsoft Corporation. All rights reserved. // Use of this source code is subject to the terms of the Microsoft end-user // license agreement (EULA) under which you licensed this SOFTWARE PRODUCT. // If you did not accept the terms of the EULA, you are not authorized to use // this source code. For a copy of the EULA, please see the LICENSE.RTF on your // install media. /** * Port Copyright (c) Hisys Corporation. All rights reserved. * @file batt_pdd.c * Abstract * This file contains battery driver PDD implementation. * Change Log * 2006.2.21 Shi Yuehua Initial Version * **/ 代码注释规范如下： //***********COMMENTS-HISTORY***********// /****************************************************************************** *NAME | SIGN | PROJECT | SUMMARY * *------------------------------------------------------------------------------ *Johson.Li M060806_A HXS006 Use the two methods to measure the battery voltage. *Johson.Li M060812_A HXS010 Change the init array value from 4 to 8. *Johson.Li M060812_B COMMON Change the USB CHANGING conditions. * ........... * ........... ******************************************************************************/ 代码注释标题声明包含四部分： 1.作者名称 2.标记符 3.项目名称 4.摘要 1.《NAME》：修改该部分CODE的软件人员名称（英文名称&中文名称拼音缩写），第一个字母大写。 2．《SIGN》：该标记符应在所有本次修改代码前面声明，主要是为了方便搜索，当我们想查找本次为了实现某个功能所做的代码修改时，可以搜索此标记符，即可找到全部修改过的相关代码段。 标记符：M060806_A M: 英文湖心亭看雪原文及翻译
C语言注释规范
《湖心亭看雪》原文及翻译
程序代码注释编写规范
《湖心亭看雪》全文翻译及注释
湖心亭看雪 湖心亭看雪原文及翻译范文
程序代码注释编写规范
《湖心亭看雪》知识点
C语言编写规范之注释
湖心亭看雪字词批注译文及知识点完全归纳
程序源代码注释规范
岳阳楼记、醉翁亭记、湖心亭看雪注释、文言现象、翻译、阅读习题及答案
湖心亭看雪原文及译文
java注释规范总结大全
湖心亭看雪批注
代码编写规范说明书
湖心亭看雪的原文和翻译
代码注释规范说明