साझा फाइलें

कुछ डॉक्युमेंटेशन फाइलें कॉन्सेप्ट अभ्यासों और प्रैक्टिस अभ्यासों, दोनों पर लागू होती हैं। ये साझा फाइलें ट्रैक की exercises/shared/.docs डायरेक्टरी में रहती हैं:

  • debug.md: बताती है कि ब्राउज़र में कोडिंग करने वाला विद्यार्थी भी "डीबगिंग" कैसे कर सकता है (वैकल्पिक)
  • help.md: मदद कैसे पाएँ, इस बारे में उस ट्रैक के लिए खास निर्देश देती है (आवश्यक)
  • representations.md: किसी हल पर कौन-से नॉर्मलाइज़ेशन लागू किए जाते हैं ताकि उसकी रिप्रेज़ेंटेशन बने, यह बताती है (वैकल्पिक)
  • tests.md: टेस्ट कैसे चलाएँ, इस बारे में उस ट्रैक के लिए खास निर्देश देती है (आवश्यक)

प्रेज़ेंटेशन डॉक्युमेंट में बताया गया है कि इन फाइलों का इस्तेमाल करके विद्यार्थी के सामने सामग्री कैसे प्रस्तुत की जाती है।

फाइल: debug.md

उद्देश्य: बताना कि ब्राउज़र में कोडिंग करने वाला विद्यार्थी भी "डीबगिंग" कैसे कर सकता है

मौजूदगी: वैकल्पिक

ब्राउज़र में मौजूद एडिटर में डीबगिंग की कोई बिल्ट-इन सुविधा नहीं है। अगर ट्रैक का टेस्ट रनर कंसोल आउटपुट कैप्चर कर सकता है, तो विद्यार्थी किसी न किसी तरह "डीबगिंग" कर ही सकता है। यह दस्तावेज़ बताता है कि यह कैसे किया जाए।

इस फाइल की सामग्री सिर्फ ऑनलाइन एडिटर में दिखाई जाती है; CLI इस फाइल को अनदेखा कर देगा।

उदाहरण

# Debug

To help with debugging, you can use the fact that any [console output](https://www.programiz.com/csharp-programming/basic-input-output) will be shown in the test results window. You can write to the console using:

```csharp
Console.WriteLine("Debug message");
```

फाइल: help.md

उद्देश्य: बताना कि विद्यार्थी मदद कैसे पा सकता है

मौजूदगी: आवश्यक

बताइए कि विद्यार्थी मदद कैसे पा सकता है, खास तौर से इसी ट्रैक के लिए (पूरे Exercism के लिए नहीं)।

इस फाइल की सामग्री सिर्फ CLI इस्तेमाल करता है, जो इसे HELP.md फाइल में शामिल करता है।

निर्देश छोटे और सीधे होने चाहिए।

आप Gitter चैनल, फोरम या मेलिंग लिस्ट जैसे संसाधनों के लिंक दे सकते हैं: जो भी विद्यार्थी को अटकाव से निकलने में मदद करे।

इस दस्तावेज़ के लिंक docs/LEARNING.md या docs/RESOURCES.md के लिंक से मिल सकते हैं।

इस दस्तावेज़ में पूरे Exercism के लिए (ट्रैक से जुड़े नहीं) मदद संसाधनों के लिंक न हों, क्योंकि वे संसाधन अपने आप HELP.md फाइल में शामिल हो जाते हैं।

उदाहरण

# Help

To get help if you're having trouble, you can use one of the following resources:

- [Kotlin Documentation](https://kotlinlang.org/docs/reference/)
- [Kotlin Forums](https://discuss.kotlinlang.org/)
- [Kotlin Slack Channel](https://kotlinlang.slack.com/): [get invite here](https://slack.kotlinlang.org/)
- [Stack Overflow](https://stackoverflow.com/questions/tagged/kotlin)
- [Kotlin Subreddit](https://www.reddit.com/r/kotlin)

फाइल: representations.md

उद्देश्य: बताता है कि किसी हल पर कौन-से नॉर्मलाइज़ेशन लागू किए जाते हैं ताकि उसकी रिप्रेज़ेंटेशन बने

मौजूदगी: वैकल्पिक

जब किसी ट्रैक ने रिप्रेज़ेंटर लागू कर लिया हो, तो हर सबमिट किए गए हल की एक रिप्रेज़ेंटेशन बनाई जाती है।

इस दस्तावेज़ में वे सारे नॉर्मलाइज़ेशन सूचीबद्ध होने चाहिए जो रिप्रेज़ेंटर किसी हल पर लागू करता है।

इससे मेंटर को रिप्रेज़ेंटेशन टिप्पणियाँ जोड़ते समय मदद मिलती है।

उदाहरण

# Representations

The representer applies the following normalizations:

- All comments are removed
- All import declarations are removed
- The code is formatted
- Identifiers are normalized to a placeholder value

अगर आपके ट्रैक में docs/REPRESENTER_NORMALIZATIONS.md फाइल है, तो हमारा सुझाव है कि नॉर्मलाइज़ेशन को उस फाइल के संबंधित हिस्से से लिंक कीजिए।

फाइल: tests.md

उद्देश्य: टेस्ट कैसे चलाएँ, इस बारे में उस ट्रैक के लिए खास निर्देश देता है

मौजूदगी: आवश्यक

बताइए कि इस खास अभ्यास के टेस्ट कैसे चलाए जाते हैं।

इस फाइल की सामग्री सिर्फ CLI इस्तेमाल करता है, जो इसे HELP.md फाइल में शामिल करता है।

निर्देश छोटे और सीधे होने चाहिए।

docs/TESTS.md फाइल में टेस्ट चलाने का ज़्यादा विस्तृत विवरण हो सकता है।

उदाहरण

# Tests

To run the tests, run the command `dotnet test` from within the exercise directory.

ओवरराइट करना

नोट: यह अब तक लागू नहीं हुआ है

अभ्यास, ट्रैक के लिए खास फाइलों को ओवरराइट कर सकते हैं। इसके लिए अभ्यास की .docs डायरेक्टरी में उसी नाम की फाइल बनाइए (जैसे .docs/debug.md)। ऐसी ज़रूरत शायद ही कभी पड़नी चाहिए (अगर पड़े भी तो)।