20221212
[devspec.git] / devspec.en_US / 3.1.code-format.txt
blob5facf5732b587a1e48714089bad7210411888218
1 \r
2 @ ³ÌÐò´úÂë·ç¸ñ\r
3 # ³ÌÐòµÄ´úÂë·ç¸ñÒÔÎÄ×Ö¶¨Ò壬ÒÔtmpl.imiÔÚ´úÂëÊä³öºÍ´úÂë¸ñʽ»¯Ê±Ê¹Óá£\r
4 # ÒÔcode-tmplĿ¼ÏµÄimiÄ£°åÎļþ¶¨Òå¸÷ÖÖ±à³ÌÓïÑÔµÄtmpl£¬ÒÔ¼°²»Í¬Ê¹ÓÃ×éºÏµÄtmpl¡£\r
5 # ÔÚsample-projectµÄdesignĿ¼ÖУ¬°üº¬Ò»¸ö´úÂëÄ£°åʹÓõÄÑùÀý¡£\r
6 \r
7 \r
8 \r
9 \r
10 ==========\r
14 # Code Style\r
15 ============\r
16     ³ÌÐòµÄ´úÂë¸ü¸ö°üº¬¶à¸ö·½Ãæ¡£\r
17 @ ºê¶¨Òå¡¢º¯Êý¡¢±äÁ¿µÄÃüÃû¹æÔò\r
18 @ ´úÂëµÄËõ½ø\r
19 @ if¡¢elseÕâÀà°üº¬£û£ýsub-routingµÄÓï·¨Óï¾äµÄ·ç¸ñ\r
20 @ º¯Êý¶¨ÒåºÍµ÷ÓÃʱµÄ¸ñʽ\r
21 @ max width\r
22 @ ´úÂë×¢ÊÍ\r
23 @ Ô´´úÂëÎļþ½á¹¹\r
24 @ ÓÃÓÚº¯ÊýµÈpublic·ÃÎʵÄÎĵµ×¢ÊÍ¡£\r
25 @ comment-stub£¬ÌØÊâÓÃ;µÄ×¢ÊÍÄÚÈÝ¡£\r
26     ÕâЩÊÇͨÓõĴúÂë·ç¸ñ£¬ÒÔ¼°°üº¬Ò»Ð©´úÂ빦ÄÜʵÏÖÉϵķç¸ñ£¬»òÕßÊdz£¼ûÄ£Ð͵ij£Óô¦Àí·½·¨£º\r
27 @ Ê¹ÓÃÊý¾Ý½á¹¹sqltg¼¸ÖÖÀàÐÍÃèÊöºÍ×éÖ¯Êý¾Ý£¬¼õÉÙ´¿buffer+Ö¸ÕëµÄʹÓÃ\r
28 @ »ù±¾µÄͨÓÃËã·¨µÄʹÓá£\r
29 @ adapterÄ£ÐÍ£¬ÀýÈçfops£¬Í³Ò»½á¹¹£¬²»Í¬adapterʹÓöÔÓ¦²»Í¬µÄº¯Êý¡£\r
30 @ registerÄ£ÐÍ£¬¶Ô¶à¸öobjµÄ×éÖ¯¹ÜÀíʹÓã¬Ã¿¸öobjÒÔÒ»ÖֽṹÁ¬½Ó£¬Í¨³£ÊÇÁ´±í¡£\r
33 # Name Style\r
34 ============\r
35     reference from chapter-2.1. and append additional guide here.\r
39 # File Structure Format\r
40 =======================\r
43 # Comment\r
44 =========\r
47 # Misc\r
48 ======\r
51 # General Implementation Style\r
52 ==============================\r