2011-10-31 6 views
14

는 클래스 나 메소드에 대한VS 2010에서 변수/필드/목록에 대한 의견/설명서를 작성하는 방법은 무엇입니까?

///<summary> 
///This is summary for some class or method 
///</summary> 

문서가있다. 그러나 이것을 간단한 변수 나리스트에 쓰는 방법은 무엇입니까?

저는 Visual Studio 2010을 사용하며 일부 목록, 속성 또는 내가 그 특정 도구에 대해 요약 한 일종의 요약을보고 싶습니다.

///<doc> 
///always use this list! 
List<String> beer = new List<String>(); 

편집 : 좋아, 우리가 클래스에 있지만, 방법 또는 함수 외부 긴 U의 주석으로 평소와 같이 작동하는지, 발견했다!

방법 내에서 문서/댓글을 쓰는 방법은 무엇입니까?

public class BeerForall 
{ 
    /// <summary> 
    /// it works here 
    /// </summary> 
    public List<String> beer = new List<string>(); 

    public String giveBeer() 
    { 
     /// is not working, u can not comment 
     /// <summary> 
     /// test test, not working 
     /// </summary> 
     List<String> moreBeer = new List<string>(); 

     return "beer"; 
    } 
} 
+3

그것은 모든 속성과 필드에 잘 작동, 아마 함수의 모든 변수에 대해 작동하지 않습니다? – gideon

+0

젠장, 당신 말이 맞아요/방법에서 작동하지 않습니다. 클래스 U에서 평소대로 문서화 할 수 있지만 메서드/함수 내에서 작동하지 않습니다! 그것을 작동시키는 어떤 방법? – Gero

+0

예, 메소드에서 작동합니까? 귀하의 방법은 어디에 정의되어 있으며 어디에서 전화하고 있습니까? 인텔리 센스로 표시되면 설명이 표시됩니다. 가끔로드하는 데 몇 초가 걸릴 수도 있습니다. – gideon

답변

10

Visual Studio 2010에서 완벽하게 작동합니다. List를 내 MainForm 클래스 내에 주석이있는 개인 필드로 정의했습니다.

함수 내에서 정의 된 로컬 변수 에는 작동하지 않습니다.

enter image description here

+0

은 클래스 자체에서 작동합니다. 그러나 메소드 내에서 무언가를 문서화하려고 시도하십시오. 내 편집 된 첫 번째 게시물을 참조하십시오. – Gero

+3

네가 내 질문에 대한 첫 번째 의견에서 말한 것은, 메서드 자체 내에서 정의 된 변수를 문서화 할 수 없습니다. – gideon

+0

ok 여기에 게시물을 편집하면 표시 할 수 있습니다! – Gero

0

변수 및 메서드에 대한 요약 작업을 작성하는 것과 같은 방법으로 변수에 대한 작업을 수행합니다.

5

는 지금까지 내가 아는 한, 인텔리에 대한 추가 의견 함수 내에서 선언 된 지역 변수에 대해 작동하지 않습니다. 지역 목록을 클래스의 인스턴스 변수로 만들려면이 작업을 수행 할 수 있어야합니다.

12

다른 언급했듯이 로컬 바를위한 IntelliSense를 얻을 수 없습니다. 그러나 : 함수가 너무 커서 "일반"주석이 var를 사용하는 곳 근처에서 읽을 수 없을만큼 가까운 경우에는 올바른 수정은 함수를 리팩토링하는 것입니다. 더 적은 vars로 더 작은 방법. 나는이 기능이 이되어야한다고 생각하지 않습니다. 너무 큰 기능을 쓰기 쉽게하기 위해서입니다.

+1

어쩌면 그게 유용 할 수있는 방법을 보지 못했을 수도 있습니다. 나는 당신이 doxygen을 살펴볼 것을 제안합니다. doxygen에서는 함수 앞에 주석을 쓸 수있는 문서가 무엇이든 관계없이 함수 안에 쓸 수 있습니다. 따라서 알고리즘에 대한 설명, 인터리빙 코드 및 문서를 리터럴 프로그래밍과 매우 비슷한 스타일로 설명 섹션과 같이 계속할 수 있습니다. 일부 코드는 많은 이점을 제공합니다. – migle

+0

리팩토링 코드는 좋지만 프로그래머와 떨어져있는 도구를 사용하는 것이 좋은 코딩 방법을 시행하는 데 유용한 "기능"이라고 생각하지 않습니다. FWIW 나는 그것이 작동하고 있다고 생각하지 않는다. 지금 유지하고있는 코드베이스를 작성한 사람은 "오 이런, 지역 변수를 주석으로 처리 할 수 ​​없으므로 코드를 더 잘 작성하게 될 것"이라고 말하지 않았다. 또한, 좋은 코딩 스타일을 장려하기 위해 정말로 제외 된 경우, 로컬 변수 Intellisense 주석은 C/C++에서 작동하지만 VS2013에서는 C#이 아닌 이유는 무엇입니까? – jrh

+2

"지나치게 큰 기능을 쓰기 쉽도록하기 위해서이 기능이 있어야한다고 생각하지 않습니다." 나는 당신이 처리해야하는 백엔드 코드의 30k + 라인을 다시 작성할 수 없다면 그것이 존재해야한다고 생각한다. –

-1

편집 : <와 같습니다. var >은 JavaScript에서만 지원됩니다.

Visual Studio 2012에서 <var> 요소를 사용하여이 설명서를 추가 할 수 있습니다.

는 여기에 마이크로 소프트의 문서입니다 :
https://msdn.microsoft.com/en-us/library/hh542722(v=vs.110).aspx

+0

불행히도 링크 된 문서는 자바에만 적용됩니다. 로컬 변수에''을 사용하려고 시도했지만 효과가 없습니다. –