2012-10-07 5 views
8

में एक विशिष्ट कोड लाइन मैं लक्ष्य में इंगित कोड में लिंक का उपयोग करके दस्तावेज़ों का प्रकार बनाना चाहता हूं। लक्ष्य Class या Method या एक विशिष्ट कोड लाइन हो सकता है। (एक विशिष्ट कोड लाइन को इंगित करना सबसे महत्वपूर्ण)
मैंने वीएस -2010 या एक विशिष्ट टिप्पणी टैग के लिए एक एक्सटेंशन के बारे में सोचा।
क्या इस तरह के लिंक बनाने का कोई तरीका है?कक्षा से लिंक करने का एक तरीका, एक विधि, विशेष रूप से सी # टिप्पणी

+3

जावाडोक इस तरह की चीज़ ठीक से करने में सक्षम था। जब माइक्रोसॉफ्ट ने नेट 1.1 जारी किया, तो उन्होंने "एनडीओसी" के साथ जावाडोक की नकल करने की कोशिश की। फिर "सैंडकासल" के पक्ष में एनडीओसी को मार डाला: http://weblogs.asp.net/fmarguerie/archive/2006/02/16/ndoc-project-stalled-no-version-2-microsoft.aspx। उनकी वर्तमान एक्सएमएल चीज, स्पष्ट रूप से, एक गड़बड़ है ... सुझाव: इसके बजाय [Doxygen] (http://www.stack.nl/~dimitri/doxygen/) का उपयोग करने पर विचार करें। – paulsm4

+0

@HichemC, कोशिश करें [यह] (http://hyperaddin.codeplex.com/) –

+1

मैंने अभी कोशिश की और मुझे लगता है कि यह ठीक काम करता है - बस ऐड-इन पंजीकृत करें और इसे सीखने के लिए Help.htm पढ़ें । अगर आपको कोई परेशानी है (क्योंकि यह वीएस 2005 और 2008 के लिए बनाया गया है) तो आप केवल समाधान (यह खुला स्रोत) का पुनर्निर्माण कर सकते हैं और इसे ठीक काम करना चाहिए। –

उत्तर

9

एक्सएमएल टिप्पणी + sandcastle आपको जो चाहिए वह हो सकता है। आपके द्वारा निर्दिष्ट वर्ग या विधि

<see cref=".."/> 

और संदर्भ मानकों का प्रयोग करके संदर्भ

<paramref name=".."/> 

का उपयोग कर फिर भी कर सकते हैं, वहाँ कोड के कुछ लाइनों को संदर्भित करने के प्रत्यक्ष विधि नहीं है, लेकिन आप

का उपयोग करके कुछ #region संदर्भित कर सकते हैं
<code source="$sourcefile$" region="$regionname$"/> 

का संदर्भ लें: XML Comments Guide पृष्ठ 20.

ध्यान दें कि आपके द्वारा संदर्भित कोड को लिंक के बजाय सीधे स्थान पर प्रदर्शित किया जाएगा। यह सही नहीं है, लेकिन मुझे उम्मीद है कि यह मदद करता है।

+0

बहुत उपयोगी उत्तर। धन्यवाद – HichemSeeSharp

संबंधित मुद्दे