有些文档文件同时适用于概念练习和实践练习。这些跨练习的文件位于轨道的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 使用,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 使用,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)。一般很少需要这样做(如果真有必要的话)。