ctrl+/

1、Variables&Code sentence

Use : // annotate

Target:

• first appearing--what,likestring _tag
• critical--why||how,like int reverse
• abstract，essential--what&(why||how)deque<pair<int, pair<ReqPack, int>>> _requests examples

      string _tag //tag handler type
      int reverse //0-only operate front of queue,1=only operate end of queue
      deque<pair<int, pair<ReqPack, int>>> _requests;//<int(start time), <ReqPack, int(alloc result)>>
  

To avoid redundancy, it will not be used

• obvious,like cycles,die[r][c]
• meaningless,like cout<<"***"

2、Function

Use : // annotate or /* annotate */

Target:

• too long--what,like

//transfer and calculate,then send flit from _buf[input]._buf to _out_flit_buffer[obus]*
void Buffer_Handler::_TransCalcu (){
    ...
}

• critical--what&how,like

// Obtain policy decision, execute acquisition buffer + write bus operation
void Buffer_Handler::_Step () {
    _CredProc();
    _TransCalcu();
}

To avoid redundancy, it will not be used

• obvious,meaingless,like_ComputeSize(),IsEmpty(),DisplayStats
• conmmon,frequent,logically similar,likeReadInput()

Note:

• English
• Use simple sentences ( concise, clear and unambiguous )