[24348] 2015-10-03_程序员应该避免的5种代码注释

文档创建者:s7ckTeam
浏览次数:3
最后更新:2025-01-18
2015-10-03_程序员应该避免的5种代码注释   5   L i n u x   2 0 1 5 - 1 0 - 0 3 5 1 . V C S 1 .   p u b l i c   c l a s s   P r o g r a m 2 .   { 3 .           s t a t i c   v o i d   M a i n ( s t r i n g [ ]   a r g s ) 4 .           { 5 .                   s t r i n g   m e s s a g e   =   " H e l l o   W o r l d ! " ;     / /   0 7 / 2 4 / 2 0 1 0   B o b 6 .                   C o n s o l e . W r i t e L i n e ( m e s s a g e ) ;   / /   0 7 / 2 4 / 2 0 1 0   B o b 7 .                   m e s s a g e   =   " I   a m   s o   p r o u d   o f   t h i s   c o d e ! " ;   / /   0 7 / 2 4 / 2 0 1 0   B o b 8 .                   C o n s o l e . W r i t e L i n e ( m e s s a g e ) ;   / /   0 7 / 2 4 / 2 0 1 0   B o b 9 .           } 1 0 .   }
2 . 使 3 . 1 .   p u b l i c   c l a s s   P r o g r a m 2 .   { 3 .           s t a t i c   v o i d   M a i n ( s t r i n g [ ]   a r g s ) 4 .           { 5 .                   / *   T h i s   b l o c k   o f   c o d e   i s   n o   l o n g e r   n e e d e d 6 .                     *   b e c a u s e   w e   f o u n d   o u t   t h a t   Y 2 K   w a s   a   h o a x 7 .                     *   a n d   o u r   s y s t e m s   d i d   n o t   r o l l   o v e r   t o   1 / 1 / 1 9 0 0   * / 8 .                   / / D a t e T i m e   t o d a y   =   D a t e T i m e . T o d a y ; 9 .                   / / i f   ( t o d a y   = =   n e w   D a t e T i m e ( 1 9 0 0 ,   1 ,   1 ) ) 1 0 .                   / / { 1 1 .                   / /         t o d a y   =   t o d a y . A d d Y e a r s ( 1 0 0 ) ; 1 2 .                   / /         s t r i n g   m e s s a g e   =   " T h e   d a t e   h a s   b e e n   f i x e d   f o r   Y 2 K . " ; 1 3 .                   / /         C o n s o l e . W r i t e L i n e ( m e s s a g e ) ; 1 4 .                   / / } 1 5 .           } 1 6 .   } 1 .   p u b l i c   c l a s s   P r o g r a m 2 .   { 3 .           s t a t i c   v o i d   M a i n ( s t r i n g [ ]   a r g s ) 4 .           { 5 .                   / *   T h i s   i s   a   f o r   l o o p   t h a t   p r i n t s   t h e   6 .                     *   w o r d s   " I   R u l e ! "   t o   t h e   c o n s o l e   s c r e e n   7 .                     *   1   m i l l i o n   t i m e s ,   e a c h   o n   i t s   o w n   l i n e .   I t 8 .                     *   a c c o m p l i s h e s   t h i s   b y   s t a r t i n g   a t   0   a n d   9 .                     *   i n c r e m e n t i n g   b y   1 .   I f   t h e   v a l u e   o f   t h e  
h a p p y 4 . 1 0 .                     *   c o u n t e r   e q u a l s   1   m i l l i o n   t h e   f o r   l o o p 1 1 .                     *   s t o p s   e x e c u t i n g . * / 1 2 .                   f o r   ( i n t   i   =   0 ;   i   <   1 0 0 0 0 0 0 ;   i + + ) 1 3 .                   { 1 4 .                           C o n s o l e . W r i t e L i n e ( " I   R u l e ! " ) ; 1 5 .                   } 1 6 .           } 1 7 .   } 1 .   p u b l i c   c l a s s   P r o g r a m 2 .   { 3 .           s t a t i c   v o i d   M a i n ( s t r i n g [ ]   a r g s ) 4 .           { 5 .                 / *   I   d i s c u s s e d   w i t h   J i m   f r o m   S a l e s   o v e r   c o f f e e   6 .                   *   a t   t h e   S t a r b u c k s   o n   m a i n   s t r e e t   o n e   d a y   a n d   h e 7 .                   *   t o l d   m e   t h a t   S a l e s   R e p s   r e c e i v e   c o m m i s s i o n   8 .                   *   b a s e d   u p o n   t h e   f o l l o w i n g   s t r u c t u r e .   9 .                   *   F r i d a y :   2 5 % 1 0 .                   *   W e d n e s d a y :   1 5 % 1 1 .                   *   A l l   O t h e r   D a y s :   5 % 1 2 .                   *   D i d   I   m e n t i o n   t h a t   I   o r d e r e d   t h e   C a r a m e l   L a t t e   w i t h 1 3 .                   *   a   d o u b l e   s h o t   o f   E s p r e s s o ?   1 4 .                 * / 1 5 .                   d o u b l e   p r i c e   =   5 . 0 0 ; 1 6 .                   d o u b l e   c o m m i s s i o n R a t e ; 1 7 .                   d o u b l e   c o m m i s s i o n ; 1 8 .                   i f   ( D a t e T i m e . T o d a y . D a y O f W e e k   = =   D a y O f W e e k . F r i d a y ) 1 9 .                   { 2 0 .                           c o m m i s s i o n R a t e   =   . 2 5 ; 2 1 .                   }
J i m 5 . 2 1 .                   } 2 2 .                   e l s e   i f   ( D a t e T i m e . T o d a y . D a y O f W e e k   = =   D a y O f W e e k . W e d n e s d a y ) 2 3 .                   { 2 4 .                           c o m m i s s i o n R a t e   =   . 1 5 ; 2 5 .                   } 2 6 .                   e l s e 2 7 .                   { 2 8 .                           c o m m i s s i o n R a t e   =   . 0 5 ; 2 9 .                   } 3 0 .                   c o m m i s s i o n   =   p r i c e   *   c o m m i s s i o n R a t e ; 3 1 .           } 3 2 .   } 1 .   p u b l i c   c l a s s   P r o g r a m 2 .   { 3 .           s t a t i c   v o i d   M a i n ( s t r i n g [ ]   a r g s ) 4 .           { 5 .                 / / T O D O :   I   n e e d   t o   f i x   t h i s   s o m e d a y   -   0 7 / 2 4 / 1 9 9 5   B o b 6 .                 / *   I   k n o w   t h i s   e r r o r   m e s s a g e   i s   h a r d   c o d e d   a n d 7 .                   *   I   a m   r e l y i n g   o n   a   C o n t a i n s   f u n c t i o n ,   b u t   8 .                   *   s o m e d a y   I   w i l l   m a k e   t h i s   c o d e   p r i n t   a   9 .                   *   m e a n i n g f u l   e r r o r   m e s s a g e   a n d   e x i t   g r a c e f u l l y . 1 0 .                   *   I   j u s t   d o n ' t   h a v e   t h e   t i m e   r i g h t   n o w . 1 1 .                 * / 1 2 .                 s t r i n g   m e s s a g e   =   " A n   e r r o r   h a s   o c c u r r e d " ; 1 3 .                 i f ( m e s s a g e . C o n t a i n s ( " e r r o r " ) ) 1 4 .                 { 1 5 .                         t h r o w   n e w   E x c e p t i o n ( m e s s a g e ) ; 1 6 .                 } 1 7 .           }
h t t p : / / w w w . s q l m a g i c . c o m / g e n e r a l / 5 - t y p e s - o f - p r o g r a m m i n g - c o m m e n t s - t o - a v o i d /   d h i r s c h l h t t p : / / w w w . c o d e c e o . c o m / a r t i c l e / 5 - t y p e s - c o m m e n t - w e - a v o i d . h t m l S t e v e   M c C o n n e l l C o d e   C o m p l e t e 1 7 .           } 1 8 .   }

您需要登录后才可以回帖 登录 | 立即注册

本版积分规则