Skip to content

Any way to document files externally to the source code? #195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
grofit opened this issue Mar 21, 2016 · 1 comment
Closed

Any way to document files externally to the source code? #195

grofit opened this issue Mar 21, 2016 · 1 comment
Labels
question Question about functionality

Comments

@grofit
Copy link

grofit commented Mar 21, 2016

I doubt this is supported and I doubt it would be an easy ask if it is not already but I kinda get annoyed when I have to make all my files really verbose and hard to read when there are comments everywhere. I love the actual documentation provided but ideally I keep hoping there would be a document generator tool which kinda works outside of your source code class and just kinda runs on it.

So is there any way that I can apply documentation to a file content without having to embed it within the raw *.ts file? just as an example I would expect something like in an ideal world:

// some-class.ts
export class SomeClass
{
   public something: string;
}
// some-class.doc.ts
/**
   #SomeClass
   This class does something
*/

/**
   #something
   This variable contains a string which doesnt do much

   @example 
   someClassInstance.something = "blah";

*/

I have yet to find a documentation tool that works this way, and it baffles me why it is not supported as in a lot of cases you just want to keep your source code clean and succinct, but when you want to provide lots of nice examples, extra docs on how things can be used and how to best use certain things it starts to get pretty wordy and a simple POJO or SRP style class ends up becoming a pretty large file with all the nice docs.

@aciccarello
Copy link
Collaborator

Look at the Content options. You may be able to include a markdown file. I haven't used it myself but saw a note about it in #247

@Gerrit0 Gerrit0 closed this as completed Oct 14, 2019
@Gerrit0 Gerrit0 added the question Question about functionality label Oct 14, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Question about functionality
Projects
None yet
Development

No branches or pull requests

3 participants