<div id="readability-page-1" class="page">
                
                
                



<nav id="global-navigation">


</nav>
<main id="wrap" aria-hidden="false">

<div>



                
                    



<article>
<header id="global-header">



<div>
<h2>Deprecated 잘쓰는 법</h2>
<ul>
<li role="text" aria-label="2023년 09월 02일 16시 51분에 작성된 글."><time datetime="2023-09-02T16:51">2023.09.02 16:51</time></li>
<li><a href="/category/Java" aria-label="Java">Java</a></li>
</ul>
</div>


</header>
<div id="article">





<ins data-ad-client="ca-pub-9527582522912841" data-ad-slot="8674651030" data-ad-format="auto" data-full-width-responsive="true" data-ad-type="inventory"></ins>


            



            <div><h2 data-ke-size="size26">Deprecated 잘쓰는 법</h2>
<p data-ke-size="size16">안쓰는 거긴하지만, 코드의 남아있는 경우 오용을 방지하기 위해서라도, Deprecated가 필요하다 그러면 이 경우 Deprecate를 사용하는 방법에 대해서 찾아봤다.<br>나는 주석에 @Deprecated를 자주 사용했는데, 그외에 다른방법이 있는지도 찾아보니, 오라클에서 제공하는 가이드라인이 존재하여 찾아보았다.&nbsp;</p>

<p data-ke-size="size16">결론을 먼저 말하자면,</p>

<p data-ke-size="size16"><b>@Deprecated라는 일반 어노테이션과, javadocs에 사용해야할 @deprecated를 동시에 섞어써야함.</b></p>

<p data-ke-size="size16">기본적으로 @Deprecated는 컴파일때 주의 문구를 띄워줌. IDE에서 노란색 줄이 그어짐. 그런데, Javadocs에만 @deprecated를 작성해놓으면 그게 적용되지 않음.</p>

<p data-ke-size="size16">즉, 문서에도 @deprecated가 적용되고 싶었더라면, docs에만 적용하는게 맞겠지만, 문서만 적용해두면 결국 그게 컴파일시에는 적용되지 않으므로 같이 적어주는게 가장 Base Practices 전략이라고 봐야한다.</p>

<p data-ke-size="size16">또한 정적 코드분석기인 소나큐브에서도 이 룰을 지키도록 하는거라서 굳이 안지킬 이유도 없다고 생각한다~<br><b>Deprecated elements should have both the annotation and the Javadoc tag</b> 라는 룰이 아예 지정되어있음.</p>
<h3 data-ke-size="size23">참고</h3>
<ul data-ke-list-type="disc">
<li><a href="https://rules.sonarsource.com/java/RSPEC-1123/">https://rules.sonarsource.com/java/RSPEC-1123/</a></li>
<li><a href="https://docs.oracle.com/javase/8/docs/technotes/guides/javadoc/deprecation/deprecation.html">https://docs.oracle.com/javase/8/docs/technotes/guides/javadoc/deprecation/deprecation.html</a></li>
<li><a href="https://stackoverflow.com/questions/20674135/deprecated-vs-deprecated">https://stackoverflow.com/questions/20674135/deprecated-vs-deprecated</a></li>
</ul>
<figure id="og_1693641052075" contenteditable="false" data-ke-type="opengraph" data-ke-align="alignCenter" data-og-type="website" data-og-title="Java static code analysis: Deprecated elements should have both the annotation and the Javadoc tag" data-og-description="Deprecation should be marked with both the <code>@Deprecated</code> annotation and @deprecated Javadoc tag. The annotation enables tools such as IDEs to warn about referencing deprecated elements, and the tag can be used to explain when it was deprecated, " data-og-host="rules.sonarsource.com" data-og-source-url="https://rules.sonarsource.com/java/RSPEC-1123/" data-og-url="https://rules.sonarsource.com/java/rspec-1123/" data-og-image=""><a href="https://rules.sonarsource.com/java/RSPEC-1123/" data-source-url="https://rules.sonarsource.com/java/RSPEC-1123/">

<div>
<p data-ke-size="size16">Java static code analysis: Deprecated elements should have both the annotation and the Javadoc tag</p>
<p data-ke-size="size16">Deprecation should be marked with both the &lt;code&gt;@Deprecated&lt;/code&gt; annotation and @deprecated Javadoc tag. The annotation enables tools such as IDEs to warn about referencing deprecated elements, and the tag can be used to explain when it was deprecated,</p>
<p data-ke-size="size16">rules.sonarsource.com</p>
</div>
</a></figure>
<figure id="og_1693641044580" contenteditable="false" data-ke-type="opengraph" data-ke-align="alignCenter" data-og-type="website" data-og-title="How and When to Deprecate APIs" data-og-description="How and When To Deprecate APIs You may have heard the term, &quot;self-deprecating humor,&quot; or humor that minimizes the speaker's importance. A deprecated class or method is like that. It is no longer important. It is so unimportant, in fact, that you should no " data-og-host="docs.oracle.com" data-og-source-url="https://docs.oracle.com/javase/8/docs/technotes/guides/javadoc/deprecation/deprecation.html" data-og-url="https://docs.oracle.com/javase/8/docs/technotes/guides/javadoc/deprecation/deprecation.html" data-og-image=""><a href="https://docs.oracle.com/javase/8/docs/technotes/guides/javadoc/deprecation/deprecation.html" target="_blank" rel="noopener" data-source-url="https://docs.oracle.com/javase/8/docs/technotes/guides/javadoc/deprecation/deprecation.html">

<div>
<p data-ke-size="size16">How and When to Deprecate APIs</p>
<p data-ke-size="size16">How and When To Deprecate APIs You may have heard the term, "self-deprecating humor," or humor that minimizes the speaker's importance. A deprecated class or method is like that. It is no longer important. It is so unimportant, in fact, that you should no</p>
<p data-ke-size="size16">docs.oracle.com</p>
</div>
</a></figure>
<figure id="og_1693641054388" contenteditable="false" data-ke-type="opengraph" data-ke-align="alignCenter" data-og-type="website" data-og-title="@deprecated vs @Deprecated" data-og-description="I'm able to deprecate a function or class with the @Deprecated annotation. But there is a @deprecated javadoc tag in a javadoc comment itself marking the class/function as deprecated. Does the @" data-og-host="stackoverflow.com" data-og-source-url="https://stackoverflow.com/questions/20674135/deprecated-vs-deprecated" data-og-url="https://stackoverflow.com/questions/20674135/deprecated-vs-deprecated" data-og-image="https://scrap.kakaocdn.net/dn/bVnL9i/hyTPxPxSTw/mLuhNAs0to5R4Bs6PidigK/img.png?width=316&amp;height=316&amp;face=0_0_316_316"><a href="https://stackoverflow.com/questions/20674135/deprecated-vs-deprecated" data-source-url="https://stackoverflow.com/questions/20674135/deprecated-vs-deprecated">

<div>
<p data-ke-size="size16">@deprecated vs @Deprecated</p>
<p data-ke-size="size16">I'm able to deprecate a function or class with the @Deprecated annotation. But there is a @deprecated javadoc tag in a javadoc comment itself marking the class/function as deprecated. Does the @</p>
<p data-ke-size="size16">stackoverflow.com</p>
</div>
</a><img src="https://scrap.kakaocdn.net/dn/bVnL9i/hyTPxPxSTw/mLuhNAs0to5R4Bs6PidigK/img.png?width=316&amp;height=316&amp;face=0_0_316_316"></figure></div>
            




                    

                    




</div>


<nav>
<ul>
<li></li>
<li></li>
<li></li>
</ul>
</nav>





















</article>


                    
                
</div>
</main>














                        
        

        

        
        


        

                
                







                
                


                
</div>

얇고 넓은 개발 블로그

Deprecated 잘쓰는 법
안쓰는 거긴하지만, 코드의 남아있는 경우 오용을 방지하기 위해서라도, Deprecated가 필요하다 그러면 이 경우 Deprecate를 사용하는 방법에 대해서 찾아봤다.
나는 주석에 @Deprecated를 자주 사용했는데, 그외에 다른방법이 있는지도 찾아보니, 오라클에서 제공하는 가이드라인이 존재하여 찾아보았다. 
 
결론을 먼저 말하자면,
 
@Deprecated라는 일반 어노테이션과, javadocs에 사용해야할 @deprecated를 동시에 섞어써야함.
 
기본적으로 @Deprecated는 컴파일때 주의 문구를 띄워줌. IDE에서 노란색 줄이 그어짐. 그런데, Javadocs에만 @deprecated를 작성해놓으면 그게 적용되지 않음.
 
즉, 문서에도 @deprecated가 적용되고 싶었더라면, docs에만 적용하는게 맞겠지만, 문서만 적용해두면 결국 그게 컴파일시에는 적용되지 않으므로 같이 적어주는게 가장 Base Practices 전략이라고 봐야한다.
 
또한 정적 코드분석기인 소나큐브에서도 이 룰을 지키도록 하는거라서 굳이 안지킬 이유도 없다고 생각한다~
Deprecated elements should have both the annotation and the Javadoc tag 라는 룰이 아예 지정되어있음.
참고
https://rules.sonarsource.com/java/RSPEC-1123/
https://docs.oracle.com/javase/8/docs/technotes/guides/javadoc/deprecation/deprecation.html
https://stackoverflow.com/questions/20674135/deprecated-vs-deprecated

Deprecated 잘쓰는 법

댓글