Menu

#16 Doxycomment for C#

v0.7
closed
c# (1)
5
2014-02-17
2014-02-03
No

It would be great if Doxycomment supported C# language.
Please consider adding support for C# (*.cs) files. Currently clicks on the plugin buttons gives such an error in the Oubput window:
"Error: Document 'filename.cs' has wrong languge."

Discussion

  • Yukinori NAKATA

    Yukinori NAKATA - 2014-02-14

    Sorry, I'm not a developer member, but I'm wondering why you need this feature.

    You can use the built in XML scripting that VisualStudio provided (just typing /// before a code element generate a template code block), and document generator tools like Doxgen and Sandcastle accept that XML comments for input.

    Please see also:
    https://sourceforge.net/p/doxycomment/discussion/536211/thread/dd494ec8/

     
    • mynewsletter

      mynewsletter - 2014-02-14

      I wasn't using VS for some time. I steel use doxygen to generate documentation.

      I would like to have DoxyComment in c# because:
      - I have no button for file comment. /// do not work for file comment in my C#.
      - When I add /// to method then I have no method parameter types. DoxyComment did that.
      - I don't know how with <see> make HyperLinks. @see works as expected. Currently I have to do that:

      /// \<summary>
      /// ABC
      /// \</summary>
      /// \<param name="sender"></param>
      /// \<param name="e"></param>
      /// @see http://sourceforge.net

      which works gut it is a mixture XML and doxygen.

      If DoxyComment works with VC++ why not with c#?

      PS. Without "\" of course.

       
      • Yukinori NAKATA

        Yukinori NAKATA - 2014-02-15

        I'm sorry about I have no permission to do that by the original author Troels Gram.

        But I tried to add C# functionality to DoxyComment and managed to do it.
        (Thanks to DoxyComment's good design/implementation and VisualStudio's powerful Extention feature).

        It's just a prototype and does not have production quality, but works fine.

        Now I can add file comment, dump code element, add code element for C#'s namespace, class, interface, struct, enum, enum value, function, delegate, event and property.

        Here is a patch.
        I hope that original author would accept it.

         
  • Robert Paasche

    Robert Paasche - 2014-02-15
    • status: open --> accepted
    • assigned_to: Robert Paasche
     
  • Robert Paasche

    Robert Paasche - 2014-02-15

    Thanks for your support I will take a look on it. tomorrow.

    /Rob

     
  • Robert Paasche

    Robert Paasche - 2014-02-15

    The patch dosen't work on the trunk.

    Can you upload your whole CSTestProvider Project?

    /Rob

     
  • Yukinori NAKATA

    Yukinori NAKATA - 2014-02-16

    Do you need CSTestProvider Project only?
    Here it is.

     
    • Yukinori NAKATA

      Yukinori NAKATA - 2014-02-16

      I created a patch again for trunk r152.
      I tested applying the patch to r152 and succeeded.
      Please use this patch.

       
  • mynewsletter

    mynewsletter - 2014-02-17

    I confirm, the patch to revision 152 works. Thanks!

     
  • Robert Paasche

    Robert Paasche - 2014-02-17
    • status: accepted --> closed
     
  • Robert Paasche

    Robert Paasche - 2014-02-17

    included in today's release

     

Log in to post a comment.

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.