2018 04 29 Coding - RYUDONGJIN/Memo_wiki GitHub Wiki

[Coding] μŠ€ν”„λ§ ν”„λ ˆμž„μ›Œν¬ 기반의 ν”„λ‘œμ νŠΈλ₯Ό μˆ˜ν–‰ν•˜κΈ° μœ„ν•΄ μ½”λ”©ν•  λ•Œ 주석(Comment)을 μž‘μ„±ν•˜λŠ” μ˜¬λ°”λ₯Έ 방법을 μ„€λͺ…ν•΄ μ£Όμ‹­μ‹œμ˜€. [ 개인적인 견해도 μ’‹μŠ΅λ‹ˆλ‹€. ]

  • 주석 μž‘μ„±μ€ ν”„λ‘œμ νŠΈλ₯Ό 진행함에 μžˆμ–΄μ„œ λ„ˆλ¬΄λ‚˜ μ€‘μš”ν•œ μš”μ†ŒλΌκ³  μƒκ°ν•©λ‹ˆλ‹€. 아무리 κΈ°μ–΅λ ₯이 쒋아도 μˆ˜λ§Žμ€ λ³€μˆ˜μ™€ ν•¨μˆ˜λ“€μ„ λͺ¨λ‘ μ™ΈμšΈ 수 μ—†κ³  그와 λ”λΆˆμ–΄ ν”„λ‘œμ νŠΈ μ’…λ£Œ 후에 μœ μ§€ 보수λ₯Ό μœ„ν•΄μ„œλΌλ„ μ£Όμ„μ˜ 역할은 λ°±μ—… λͺ»μ§€ μ•Šκ²Œ μ€‘μš”ν•˜λ‹€κ³  μƒκ°ν•©λ‹ˆλ‹€.

  • JSP νŒŒμΌμ—λŠ” ν”„λ‘œμ νŠΈ λͺ…κ³Ό μž‘μ„±μž, μž‘μ„±μΌ, Commentλ₯Ό μž‘μ„±ν•©λ‹ˆλ‹€.

[JSP]
<%--
/**
 * @Project  : 
 *
 * @author  : 
 * @since  : ${date}
 * @Comment :  
 *         이름 :         일자 : 
 *         λ³€κ²½λ‚΄μš© :
 * ===============================================
 *                   
 */
 --%>
  • XML νŒŒμΌμ—λŠ” ν”„λ‘œμ νŠΈλͺ…κ³Ό μž‘μ„±μž, μž‘μ„±μΌ, Commentλ₯Ό μž‘μ„±ν•©λ‹ˆλ‹€.
[XML]
<!-- /**
 * @Project  : 
 *
 * @author  :  
 * @since  : ${date}
 * @Comment : 
 *         이름 :         일자 : 
 *         λ³€κ²½λ‚΄μš© :
 * ===============================================
 *    
 */ -->
  • Class νŒŒμΌμ—λŠ” 클래슀λͺ…κ³Ό 파일λͺ…, νŒ¨ν‚€μ§€μ™€ Comment, μž‘μ„±μž, μž‘μ„±μΌμ„ μž‘μ„±ν•©λ‹ˆλ‹€.
[Class]
/**
 * <PRE>
 * @ClassName : ${enclosing_type}
 * @FileName  : ${file_name}
 * @Package  : ${package_name}
 * @Comment  : 
 * @author   : ${user}
 * @since   : ${date} ${time}
 * </PRE>
 */
  • μƒμ„±μžμ—λŠ” λ©”μ†Œλ“œ 이름과 클래슀λͺ…, Comment와 μž‘μ„±μž, μž‘μ„±μΌμ„ μž‘μ„±ν•©λ‹ˆλ‹€.
[μƒμ„±μž]
/**
 * <PRE>
 * @MethodName : ${enclosing_type}
 * @ClassName  : ${enclosing_type}
 * @Comment   : 
 * @author    : ${user}
 * @since    : ${date} ${time}
 * </PRE>
 *   ${tags}
 */
  • λ©”μ†Œλ“œμ—λŠ” λ©”μ†Œλ“œλͺ…κ³Ό 클래슀λͺ…, Comment, μž‘μ„±μž, μž‘μ„±μΌ, λ©”μ†Œλ“œμ˜ λ§€κ°œλ³€μˆ˜μ™€ 리턴값을 μž‘μ„±ν•©λ‹ˆλ‹€.
[λ©”μ†Œλ“œ]
/**
 * <PRE>
 * @MethodName : ${enclosing_method}
 * @ClassName  : ${enclosing_type}
 * @Comment   : 
 * @author   : ${user}
 * @since    : ${date} ${time}
 * </PRE>
 *   @param  data
 *   @return ${return_type}
 *   ${tags}
 */
⚠️ **GitHub.com Fallback** ⚠️