zeroc-ice / ice

All-in-one solution for creating networked applications with RPC, pub/sub, server deployment, and more.
https://zeroc.com
GNU General Public License v2.0
2.06k stars 591 forks source link

Is There a Point to Supporting Both `["deprecated"]` Metadata and the `@deprecated` Comment Tag? #3225

Open InsertCreativityHere opened 23 hours ago

InsertCreativityHere commented 23 hours ago

And if there is, is there some clear guidance we should offer users as to what the difference is between:

/// Does a cool thing.
["deprecated:you shouldn't use this thing"]
myOperation();

vs

/// Does a cool thing.
/// @deprecated you shouldn't use this thing
myOperation();

To me, it feels like only having one of these would be sufficient. And I would especially like to avoid requiring users to do this:

/// Does a cool thing.
/// @deprecated you shouldn't use this thing
["deprecated:you shouldn't use this thing"]
myOperation();
bernardnormier commented 21 hours ago

The deprecated metadata and optional message has two purposes:

On the other hand, the @deprecated doc-comment tag is about: