JetBrains Rider - is there an easy way to generate the XML documentation file?

Question

VS has a checkbox that just builds the XML documentation file from C#. I couldn't find anything like this in JetBrains Rider's build settings. What's the easiest way to do this?

xtmq · Accepted Answer · 2022-01-02 18:56:41Z

21

You have to open Solution Explorer, choose the appropriate project, go to project properties and enable generating for the specific project configuration (or all of them):

answered Jan 2, 2022 at 18:56

xtmq

3,80326 silver badges30 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

user1026169 Over a year ago

Thanks! It wasn't coming up in the other options menu's.

xtmq Over a year ago

Yes, I have noticed =) How you tried to find it? Via search in settings?

user1026169 Over a year ago

Yeah, I had tried searching for a few queries and gave up after 10-15 minutes. Maybe I was searching the wrong terms though. Would be great if it came up in the search box.

Korfu · Accepted Answer · 2022-01-02 18:42:59Z

1

Rider has public Youtrack (tool to track issues). For the future I recommend to check there before posting here, as usually it has been raised there.

Here is a link to the issue about XML documentation: https://youtrack.jetbrains.com/issue/RIDER-7433?_ga=2.64467503.1034831768.1641148468-999122819.1639050883

Workaround to achieve it is to add to the .csproj file

  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
    <DocumentationFile>bin\Debug\netcoreapp1.1\PowerBiApiService.xml</DocumentationFile>
  </PropertyGroup>

answered Jan 2, 2022 at 18:42

Korfu

8511 gold badge8 silver badges23 bronze badges

3 Comments

user1026169 Over a year ago

Thanks, I posted a comment there as suggested. That workaround is from 2017, hoping there has been more traction since then.

Korfu Over a year ago

You are right this one is quite out-of-date it seems that this now the up-to-date feature request: youtrack.jetbrains.com/issue/…. But still not implemented as of now

xMaxrayx Sep 15 at 21:13

why you wnat empty doc? if you want to write them you can type /// above the method and Rider do generation for that method.

Collectives™ on Stack Overflow

JetBrains Rider - is there an easy way to generate the XML documentation file?

2 Answers 2

3 Comments

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

3 Comments

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related