क्या मेरे समय के बराबर ASCII आरेख हैं?

Question

क्या एएससीआईआई आरेख स्रोत कोड के भीतर हैं जो वे बनाने के लिए लेते हैं?

मैं बिटमैप आरेख को बहुत तेज बना सकता हूं, लेकिन स्रोत फ़ाइल (until VS2010) में छवियों में छवियों को और अधिक कठिन बनाना है।

रिकॉर्ड के लिए, मैं decorative ASCII art के बारे में बात नहीं कर रहा हूं।

यहां हाल ही में मेरे कोड के लिए बनाए गए आरेख का एक उदाहरण है जिसे मैं शायद एमएस पेंट में आधे समय में बनाया हो सकता था।

  Scenario A: 

          v 
(U)____________(N)_______<--(P)     Legend: 
      ' /   |     J = ... 
      ' /   |     P = ... 
      ' /d    |     U = ... 
      '/    |     v = ... 
      '/    |     d = ... 
      '/     |     N = ... 
     (J)     | 
      |     | 
      |___________________| 

Answer 1

यदि आप डॉक्सिजन जैसे कोड से दस्तावेज़ उत्पन्न करने के लिए टूल का उपयोग करते हैं, तो छवि फ़ाइल को सीधे संदर्भित करने का तरीका होना चाहिए और इसे जेनरेट किए गए दस्तावेज़ों में दिखाई देना चाहिए। Doxygen के लिए, प्रासंगिक आदेश \image है। यह स्रोत से संदर्भ की आसानी के साथ वास्तविक छवि आरेख होने के लाभ को जोड़ता है (वर्ड जैसे भारी कार्यक्रम को आग लगाने की आवश्यकता नहीं है), और आपके ऑटो-जेनरेट किए गए दस्तावेज़ों के साथ भी।

Answer 2

आपका समय बेहतर वर्णनात्मक चर और समारोह के नाम की यह टिप्पणी को समझने के लिए की आवश्यकता नहीं है के साथ स्पष्ट और संक्षिप्त कोड लिखने के लिए उपयोग किया जाएगा। न तो टिप्पणियां और न ही डिज़ाइन दस्तावेज़ संकलित करें। नतीजतन, वे जल्दी से कोड के साथ सिंक से बाहर हो जाते हैं और भ्रामक बन जाते हैं।

Answer 3

इसे आज़माएं: इन्हें गतिशील रूप से एक साथ रखने के लिए अच्छी लाइब्रेरी। http://code.google.com/p/clojure-textflow/

Answer 4

फिर एमएस पेंट (या जो कुछ भी) का उपयोग करें और अपने स्रोत नियंत्रण में आरेख शामिल करें।

Answer 5

डिज़ाइन दस्तावेज़ एक डिज़ाइन दस्तावेज़ में संबंधित है। चित्रों, मैनुअल, स्रोत, उदाहरण डेटा फ़ाइलों, परीक्षण मामलों, इच्छा सूची, परिवर्तन लॉग इत्यादि के लिए उपफोल्डर्स के साथ एक प्रोजेक्ट फ़ोल्डर क्यों नहीं है। मैं यह नहीं कह रहा हूं कि प्रत्येक दस्तावेज़ प्रकार को एक अलग निर्देशिका की आवश्यकता होती है, लेकिन चीजों को तर्कसंगत रूप से व्यवस्थित किया जाना चाहिए ।

बाहरी फ़ाइल खोलने का समय ASCII कला बनाने के लिए बर्बाद समय के बाद कोई मुद्दा नहीं है, और जब कोई अलग संपादक या फ़ॉन्ट का उपयोग करता है तो यह कितनी जल्दी गिरता है।

Answer 6

अपने दर्शकों को जानें। क्या आपके दर्शक (भविष्य में अन्य डेवलपर्स) अपने निपटान में उपकरण के साथ बस और आसानी से बिटमैप तक पहुंच सकते हैं? आरेख उपयोगी/उपयोगी है?

कोड की टिप्पणियों में एक ASCII आरेख लगभग हमेशा आसानी से देखा जा सकता है। (हां, कुछ समस्याएं हो सकती हैं यदि विस्तारित ASCII वर्णों का उपयोग किया गया था, या यदि डेवलपर गैर-निश्चित चौड़ाई फ़ॉन्ट का उपयोग कर रहा है।)

Answer 7

मैं अन्य पोस्टर से सहमत हूं: कुछ भी जो कोड नहीं है (और थोड़ा सा टिप्पणियों का, लेकिन बहुत वर्बोज़ नहीं) कहीं और होना चाहिए, चाहे वह विकी या दस्तावेज़ हो।

मैं अतीत में होने वाली विभिन्न दुर्घटनाओं के कारण शब्द से बचना पसंद करूंगा लेकिन यह व्यक्तिगत वरीयता हो सकती है। बस एक और बात: सामान के लिए अच्छे नाम रखने का प्रयास करें और उन्हें अपने कोड और अपने दस्तावेज़ों के बीच एक लिंक के रूप में उपयोग करें। तो यदि आपके पास कक्षा (या एक दिनचर्या, या एक मॉड्यूल) है जो आपके द्वारा उदाहरण के रूप में दिखाए गए परिदृश्यों से संबंधित है, तो कृपया इसे स्क्वायरबिसेक्टर या इस तरह कुछ कहें, और इसकी विधियां परिदृश्य हों (प्वाइंट ए, प्वाइंट बी), परिदृश्य बी (प्वाइंट ए, लाइन एल 1) और इसी तरह, और फिर एक सतत शब्दावली का उपयोग कर दस्तावेज़ में, बहुत सारे आरेखों के साथ, उन्हें उच्च स्तर के शब्दों में समझाते दस्तावेज़ों को लिखें।

कृपया अपने तरीके "bisectWithTwoPoints (प्वाइंट firstPoint, प्वाइंट secondPoint) कोड और" परिदृश्य ए 'दस्तावेज में ...

Answer 8

तुम वहाँ बाहर विभिन्न ASCII आर्ट कन्वर्टर्स में देखा है कहें? इस तरह आप पेंट में जल्दी से आकर्षित कर सकते हैं या फिर भी इसे एएससीआईआईआई कला निर्यात कर सकते हैं।

Answer 9

आप स्रोत टीम में VS2010 और embed actual images का उपयोग करने के लिए अपनी टीम पर सभी को प्राप्त कर सकते हैं।

Answer 10

कभी-कभी एक ASCII आरेख वास्तव में हजारों शब्दों के लायक है। लेकिन अक्सर नहीं। मैं अपनी सभी स्रोत फ़ाइलों को नहीं खोजूंगा, लेकिन मुझे लगता है कि कोड के 20,000 लाइनों के प्रति एक आरेख सही हो सकता है (या कम से कम दो कारकों से अधिक नहीं)।

कोई भी जो कोड को एक स्थान पर रखने और दूसरे में आरेख को इंगित करने का सुझाव देता है, वह दोनों को असंगत बनने के लिए भीख मांगता है। एक अलग शब्द दस्तावेज़ की तुलना में कोई आरेख या क्रैपी ASCII आरेख नहीं है जो गलत है।

Answer 11

आप सुंदर साधारण वर्ग/प्रवाह आरेखों और इसी तरह के चित्र बनाने के लिए http://www.asciiflow.com का उपयोग कर सकते हैं। यह जावास्क्रिप्ट का उपयोग कर पूरी तरह से वेब आधारित है। क्रोम/फ़ायरफ़ॉक्स की सिफारिश की।

Answer 12

मैंने Python Wiki पर ASCII आरेखों को चित्रित करने के लिए लिंक की एक सूची और एक छोटा ट्यूटोरियल संकलित किया है। कोई भी चित्र जो आपको पाठ पढ़ने में कुछ समय बचाता है, वह निश्चित रूप से समय के लायक है।