java 인 코딩 규범 -- 주석

4926 단어 자바

                                                    [size=large]    [/size]
1、     ,           20%  。

2、     (    .h  、.inc  、.def  、      .cfg )       ,      :    、   、    、  、  、  、        、     ,                  。
      :
    /*************************************************
     Copyright (C), 1988-1999, Huawei Tech. Co., Ltd.
     File name: //    
      Author: Version: Date: //   、        
      Description: //                   ,     
                          //       ,   、    、        
                          //  、  、        
       Others: //        
        Function List: //       ,                 
           1. ....
         History: //         ,             、  
        //         
        1. Date:
         Author:
         Modification:
          2. ...
        *************************************************/
3、          ,  :    、   、    、  、    /  、        、     。
       :
       /************************************************************
       Copyright (C), 1988-1999, Huawei Tech. Co., Ltd.
        FileName: test.cpp
        Author: Version : Date:
        Description: //     
        Version: //     
         Function List: //         
        1. -------
        History: //       
        <author> <time> <version > <desc>
          David 96/10/12 1.0 build this moudle
         ***********************************************************/
       
            :Description          、  、                      。History         ,             、          。

4、         ,  :     /  、    、    、   、    (  、 ) 。

     :             ,  ,        ,            。
   
   /*************************************************
   Function: //     
   Description: //     、      
   Calls: //            
   Called By: //           
   Table Accessed: //      (                )
   Table Updated: //      (                )
   Input: //       ,        
   //  、          。
   Output: //         。
   Return: //         
   Others: //     
   *************************************************/

5、       ,             ,            。          。

6、            ,               (        )    ,      ,                   。

   :
   /* get replicate sub system index and net indicator */
   repssn_ind = ssn_data[index].repssn_index;
   repssn_ni = ssn_data[index].ni;

7、            、  ,             ,           ,       。  、  、                 。
     :
   /* active statistic task number */
   #define MAX_ACT_TASK_NUMBER 1000

   #define MAX_ACT_TASK_NUMBER 1000 /* active statistic task number */

8、:      (    、  、 、   ),             ,      。                  ,      ;             

     。

9、            ,      、    、                       。

10、               。 
      :
    /* code one comments */
     program code one

    /* code two comments */
     program code two

11、           (    、     )      。
      :                    ,        ,              ,           。

12、  switch    case  ,               case      case  ,    case     、   case          。
      :              ,        break  。
    
      (        ):
    case CMD_UP:
    ProcessUp();
    break;

    case CMD_DOWN:
    ProcessDown();
    break;

   case CMD_FWD:
   ProcessFwd();
   if (...)
   {
     ...
     break;
   }
   else
  {
   ProcessCFW_B(); // now jump into case CMD_A
   }

   case CMD_A:
   ProcessA();
   break;

   case CMD_B:
   ProcessB();
   break;

   case CMD_C:
   ProcessC();
   break;

  case CMD_D:
  ProcessD();
  break;
  ...

13、        、  、                    ,         。
      :       、      ,        ,         。

14、      、         ,    、     。
      :             、        ,         ,        ,            。

15、               ,          。
      :      ,        ,           ,     。
      :      。 
    if (...)
    {
       // program code
       while (index < MAX_INDEX)
       {
          // program code
       } /* end of while (index < MAX_INDEX) */ //     while    
     } /* end of if (...)*/ //      if    

16、        ,    “/* …… */”。

17、:                 ,        、    ,       ,               。










좋은 웹페이지 즐겨찾기