{"action":"created","issue":{"url":"https://api.github.com/repos/Microsoft/visualfsharp/issues/3374","repository_url":"https://api.github.com/repos/Microsoft/visualfsharp","labels_url":"https://api.github.com/repos/Microsoft/visualfsharp/issues/3374/labels{/name}","comments_url":"https://api.github.com/repos/Microsoft/visualfsharp/issues/3374/comments","events_url":"https://api.github.com/repos/Microsoft/visualfsharp/issues/3374/events","html_url":"https://github.com/Microsoft/visualfsharp/issues/3374","id":245215451,"number":3374,"title":"XML comments and shorthand \"///\" comments do not always appear in quick-info tooltips in VS2017","user":{"login":"abelbraaksma","id":16015770,"avatar_url":"https://avatars1.githubusercontent.com/u/16015770?v=4","gravatar_id":"","url":"https://api.github.com/users/abelbraaksma","html_url":"https://github.com/abelbraaksma","followers_url":"https://api.github.com/users/abelbraaksma/followers","following_url":"https://api.github.com/users/abelbraaksma/following{/other_user}","gists_url":"https://api.github.com/users/abelbraaksma/gists{/gist_id}","starred_url":"https://api.github.com/users/abelbraaksma/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/abelbraaksma/subscriptions","organizations_url":"https://api.github.com/users/abelbraaksma/orgs","repos_url":"https://api.github.com/users/abelbraaksma/repos","events_url":"https://api.github.com/users/abelbraaksma/events{/privacy}","received_events_url":"https://api.github.com/users/abelbraaksma/received_events","type":"User","site_admin":false},"labels":[{"id":308804753,"url":"https://api.github.com/repos/Microsoft/visualfsharp/labels/Area-IDE%20Language%20Service","name":"Area-IDE Language Service","color":"5319e7","default":false},{"id":164789606,"url":"https://api.github.com/repos/Microsoft/visualfsharp/labels/bug","name":"bug","color":"fc2929","default":true},{"id":295294041,"url":"https://api.github.com/repos/Microsoft/visualfsharp/labels/Urgency-Now","name":"Urgency-Now","color":"e11d21","default":false}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":6,"created_at":"2017-07-24T21:32:00Z","updated_at":"2017-08-22T17:33:41Z","closed_at":null,"body":"I tested this with the latest VS2017 Preview 4.\r\n\r\nThe XML comments or the shorthand comments that generate quick-info information are invaluable, but since VS2017, through to Preview 4, they sometimes appear, and sometimes don't.\r\n\r\nIt seems to happen only when the declaration is in a different project in the same solution (both are F# projects). The tooltip shows correctly in the home project (the one it is declared in) but not in the host project (the using project). \r\n\r\nDeclaration:\r\n\r\n![image](https://user-images.githubusercontent.com/16015770/28545233-82119c3c-70c6-11e7-9729-3afe1dcd12db.png)\r\n\r\nIn a using project:\r\n\r\n![image](https://user-images.githubusercontent.com/16015770/28545326-e1a3d318-70c6-11e7-9c50-081d2a7c900f.png)\r\n\r\n### Repro steps\r\n\r\nI have tried to repro this with smaller projects linking each other, but each time I do that, it just works. So no repro yet. \r\n\r\n### Expected behavior\r\n\r\nQuick-info tooltips should show the XML comment.\r\n\r\n### Actual behavior\r\n\r\nOften tooltips do not show the XML comment.\r\n\r\nNote that in this particular project, there seems to be no line in what gets rendered into the tooltip and what not. I checked:\r\n\r\n* Whether the comment actually contains XML\r\n* Whether the it's a type, a module, a let-binding, a value, a discriminated union type, a discriminated union field\r\n* Clean - rebuild\r\n* Restart VS\r\n\r\nNone of these seemed to matter. Sometimes the comment is shown, sometimes it is not. I thought it might have to do with background processing (sometimes you see the \"...\" in the intellisense dropdowns, but once these are gone, the actual tooltip is still without XML comment rendering.\r\n\r\n### Known workarounds\r\n\r\nFalling back to VS2015 helps, it has no problems with the quick-info tooltips.\r\n\r\nOther than that, no workarounds found any yet. I'd be very eager to hear whether I can clean some specific cache files or anything to fix this.\r\n\r\n### Related information \r\n\r\n* Win7, Visual Studio 2017 Preview 4\r\n* Project uses FSharp.Core 4.4.0.0.\r\n* .NET 4.6 (CLR version: v4.0.30319)\r\n\r\nMaybe not a big bug, but rather annoying as in this (and other) big projects I rely heavily on the these quick-infos. \r\n\r\nAs an aside and a compliment: using F12 hardly ever worked in VS2015, not even within the same project, but it always succeeds in VS2017, so: *chapeau! and a big thank you! for the developers*, it mitigates this issue a little as I can more easily go to the definition and check the XML comments there.\r\n"},"comment":{"url":"https://api.github.com/repos/Microsoft/visualfsharp/issues/comments/324097758","html_url":"https://github.com/Microsoft/visualfsharp/issues/3374#issuecomment-324097758","issue_url":"https://api.github.com/repos/Microsoft/visualfsharp/issues/3374","id":324097758,"user":{"login":"abelbraaksma","id":16015770,"avatar_url":"https://avatars1.githubusercontent.com/u/16015770?v=4","gravatar_id":"","url":"https://api.github.com/users/abelbraaksma","html_url":"https://github.com/abelbraaksma","followers_url":"https://api.github.com/users/abelbraaksma/followers","following_url":"https://api.github.com/users/abelbraaksma/following{/other_user}","gists_url":"https://api.github.com/users/abelbraaksma/gists{/gist_id}","starred_url":"https://api.github.com/users/abelbraaksma/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/abelbraaksma/subscriptions","organizations_url":"https://api.github.com/users/abelbraaksma/orgs","repos_url":"https://api.github.com/users/abelbraaksma/repos","events_url":"https://api.github.com/users/abelbraaksma/events{/privacy}","received_events_url":"https://api.github.com/users/abelbraaksma/received_events","type":"User","site_admin":false},"created_at":"2017-08-22T17:33:41Z","updated_at":"2017-08-22T17:33:41Z","body":"@dsyme, it seemed that I misinterpreted how the new options from @vasily-kirichenko's fix in #3330 work. Now that he gave an excellent explanation I can now confirm that:\r\n\r\n* after switching **OFF** the setting for *Enable in-memory cross-project references*, then rebuilding, then closing and reopening the solution, the QuickInfo tooltips show the documentation again.\r\n* when it is switched to **ON**, the documentation in the tooltips disappears.\r\n* **rebuilding the solution will remove the documentation from the tooltips, only VS restart shows them again.**\r\n\r\nAbout your earlier comment:\r\n\r\n> The fixes would be\r\n> \r\n>   1. store the XML doc information in the TAST pickled metadata when doing in-memory compilation of a dependent project. This needs care though because we can't change the format in the on-disk case.\r\n>   2. make HasDirectXmlComment return true for symbols coming from in-memory compilations\r\n\r\nThis seems to be quite a tough one to fix? So I would assume that, provided you need those comments to work, users should get accustomed to restarting Visual Studio after each build, if you need the tooltips?\r\n\r\nPerhaps there's a way we can use the on-disk assemblies and reload them when they are changed? This would prevent users to have to restart VS all the time.\r\n"}}
{"actor":{"display_login":"abelbraaksma"}}