English 中文(简体)
我在文件中需要作些什么?
原标题:What do I need to cover in my documentation?

我为我撰写的《第三号行动》小文图书馆撰写自己的文件。

我试图像我那样,保持Adobe Livedocs的布局和内容,同时把它打上一点点。

我认为,我谈到了人们在阅读我的文件时所要知道的一切,但是,在我开始增加我所创造的所有类别之前,我不想错过任何至关重要的东西。

是否有任何人希望获得某种文件? 你们是否认为不必要?

https://projectavian.com

我试图掩盖的一些事情是:

  1. Easy direct links to documentation sections. ie /#/class.propertyOrMethod as above.
  2. Neat tables at the top of the page listing briefly each property, method, constant or whatever other relevant staples are present in the class.
  3. Clearly separated blocks of information relating to each property or method which can be navigated to directly by the URL in step 1. Clicking the relevant text in the tables at the top of the page will also link down to here.
  4. Tidy layout for method arguments with concise explanations about each.
最佳回答

我确实喜欢文件的设计。 当我第一次提及其他相关工作以确保我涵盖所有同样的基础时。 尽管如此,我认为你 covered。

我知道的一些有文件证明的辅助班级:

TweenMax @ http://www.greensock.com/as/docs/tween/com/greensock/TweenMax.html BulkLoader @ http://media.stimuli.com.br/projects/bulk-loader/docs/ CASA Lib @ http://as3.casalib.org/docs/

你们可能会把他们推向高度精细的行动类,即: 每一次都是通过多种版本的释放和经受时间考验。

问题回答

暂无回答




相关问题
Logback tutorial [closed]

Where can I find a Logback tutorial and/or sample projects? Something similar with this "Log4j Tutorial" would be nice. Note: I am aware of the documentation available on the official Logback website ...

How to document the Main method? [closed]

Okay, so I ve got a .NET console application with it s Main method, contained in a Program class. You know, the usual: class Program { static void Main(string[] args) { // Do ...

javadoc: show also descriptions of methods from parent class

Is there a way to produce javadoc so that all methods accessible from the class are listed with their full description? Usually only the methods defined in that class are listed and the rest are only ...

Is there a list of known web crawlers? [closed]

I m trying to get accurate download numbers for some files on a web server. I look at the user agents and some are clearly bots or web crawlers, but many for many I m not sure, they may or may not be ...

热门标签