fsharp / fsharp/fslang-suggestions

Support markdown in documentation comments

Open
#237 8 comments 20 reactions 0 assignees View on GitHub
approved-in-principle area: tooling proposed-priority
Dominant language
No language data
Stars
373
Forks
21
PR merge metrics
No merged PRs in 30d

Description

**Submitted by Anonymous on 4/2/2014 12:00:00 AM**
**19 votes on UserVoice prior to migration**

F# currently supports documentation comments with either XML tags or no tags. The no tags format is convenient to write, but does not allow formatting the comments for the VS IDE. Use of XML tags allows formatting the documentation comment, but the act of writing the documentation comment becomes a heavy burden as XML is not a very convenient format for manual editing. I would like to suggest supporting some lighter-weight formatting syntax such as markdown.

**[Original UserVoice Submission](https://fslang.uservoice.com/forums/245727-f-language/suggestions/5716959)**
[Archived Uservoice Comments](../tree/master/archive/suggestion-5716959-support-markdown-in-documentation-comments.md#comments)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.