• Visitors can check out the Forum FAQ by clicking this link. You have to register before you can post: click the REGISTER link above to proceed. To start viewing messages, select the forum that you want to visit from the selection below. View our Forum Privacy Policy.
  • Want to receive the latest contracting news and advice straight to your inbox? Sign up to the ContractorUK newsletter here. Every sign up will also be entered into a draw to WIN £100 Amazon vouchers!

Documenting c# Classes

Collapse
X
  •  
  • Filter
  • Time
  • Show
Clear All
new posts

    Documenting c# Classes

    Anyone got any tips - preferably outputting to word
    Need something like

    Abstract Class
    -property
    -property
    -method
    -method etc..
    class - inherits abstract class
    -property
    -property
    -method
    -method etc..

    etc etc etc
    Coffee's for closers

    #2
    good summary of options here though the question in the link is a bit stupid itself.

    Comment


      #3
      Originally posted by Spacecadet View Post
      Anyone got any tips - preferably outputting to word
      Need something like

      Abstract Class
      -property
      -property
      -method
      -method etc..
      class - inherits abstract class
      -property
      -property
      -method
      -method etc..

      etc etc etc
      The best thing for this is Sandcastle.

      I've used it in the past for almost the same same reasons as yourself. Be warned, though, that it's not the most "polished" utility, and will require that you've decorated your classes/functions with /// style xml comments and will also require you to craft some xslt files to style the output. Oh, and it's all command line-driven.

      Comment


        #4
        Originally posted by billybiro View Post
        The best thing for this is Sandcastle.

        I've used it in the past for almost the same same reasons as yourself. Be warned, though, that it's not the most "polished" utility, and will require that you've decorated your classes/functions with /// style xml comments and will also require you to craft some xslt files to style the output. Oh, and it's all command line-driven.
        I've found this useful for processing the embedded XML doc and interfacing to sandcastle.

        Sandcastle Help File Builder - Download: SHFB v1.9.3.0 Release

        Comment


          #5
          Originally posted by ASB View Post
          I've found this useful for processing the embedded XML doc and interfacing to sandcastle.

          Sandcastle Help File Builder - Download: SHFB v1.9.3.0 Release
          Sandcastle but I happily used GhostDoc for ages (considering everyone else used nothing it made me look organised).
          merely at clientco for the entertainment

          Comment

          Working...
          X