如何自制一个js文档生成器满足公司的特定需求?

ElenaQ 2016-10-09 02:58:41
大四学生一枚,javascript初学者,目前在实习,公司的有一套自己的框架,只需要javascript就可以实现前台和后台,但是关于这个框架的文档是很久以前手写的,跟真正的框架源码甩了好几条街
我希望能够开发一个针对本公司的js文档生成器,源码如下
ui.require('Button');
ui.version.Table = '2.0';
ui.comp.Table = ui.extend('', {
constructor: function(param) {
ui.comp.Table.superclass.constructor.apply(this, arguments);
this.width = 'auto';
this.height = 'auto';
},
focusPreScrollTop:function(focused,num){
var container = this.domObj_listContainer.find('.kui-table-content');
var item = container.find('.kui-table-row-focus');
if(item.size()>0){
var itemTop = item.offset().top;
var toolTop = this.domObj_header.offset().top;
var height = this.domObj_header.outerHeight(true);
if(itemTop < (toolTop+height)){
var temp = itemTop - (toolTop+height);
container.scrollTop(this._getScrollTop(temp,focused,item,num));
}
}
}
});

已有的文档内容如下
<tr>
<th>属性名</th>
<th>简介</th>
</tr>
<tr>
<td>id</td>
<td>默认值无(AUTO_INCREMENT). 允许格式:字符串。<br/>此属性用于设置组件的id。如不指定,框架会使用一个页面唯一的内部id,命名格式为<i>kui-n</i>,n为一个自增长数字。为组件指定id后,可通过ui.getObjectById( id )方法快速获取组件对象。</td>
</tr>
<tr>
<td>container</td>
<td>默认值"body". 允许格式:jquery 选择器或jquery DOM 对象。<br/>此属性用于设置组件的上级容器。默认body 即表示绘制在页面body元素下。可指定一个jquery 选择器或DOM 对象,如 container : '#myDiv' 或 container : $('#myDiv')</td>
</tr>
<tr>
<td>width</td>
<td>默认值'auto'. 允许格式:数字(单位像素)或字符串(百分比或auto)。<br/>此属性用于设置Block的宽度。默认auto,将撑满水平宽度。</td>
</tr>

除了tr, td中的内容其它不需要改变,我的初步想法是将jsDoc的源码拿来改,但是又不知道如何下手,看不太懂jsDoc的源码
但是如果自己从头开始写一个文本分析工具一样的文档生成器,是不是重复造轮子?
还希望各位大神给我一点建议,感激不尽
...全文
9312 25 打赏 收藏 转发到动态 举报
写回复
用AI写文章
25 条回复
切换为时间正序
请发表友善的回复…
发表回复
浪子回头8 2017-04-12
  • 打赏
  • 举报
回复
文档要自己写吧,程序没那么智能的!
江南小鱼 2017-03-29
  • 打赏
  • 举报
回复
没太懂撸主表达的意思 这一句 公司的有一套自己的框架,只需要javascript就可以实现前台和后台 让我眼前一亮
贝加尔_湖畔 2017-02-17
  • 打赏
  • 举报
回复
自动生成文档有什么意义?是要批量写很多相似的文档所以才想着代码实现么?
shimingliang 2017-02-17
  • 打赏
  • 举报
回复
自动生成文档。。有意义吗? 如果只是生成接口的话,那可以,但是什么解释,还得例子,那绝对是得手打啊。
疲劳编码 2017-02-10
  • 打赏
  • 举报
回复
没动什么意思呀
鱼弦 2016-12-31
  • 打赏
  • 举报
回复
JLXCSS 2016-12-19
  • 打赏
  • 举报
回复
引用 17 楼 JLX_XLJ 的回复:
楼主说得对啊
引用 16 楼 mLee79 的回复:
js 干这种活应该蛮容易的吧, 前几天刚用 js 写了个 LALR(1) parser, 用来解析解析简单的文件啊, 写个简单的语言类似 C 的啊啥的编译器/解释器啥的都特别方便 ....
你说得对啊啊
JLXCSS 2016-12-19
  • 打赏
  • 举报
回复
楼主说得对啊
mLee79 2016-12-14
  • 打赏
  • 举报
回复
js 干这种活应该蛮容易的吧, 前几天刚用 js 写了个 LALR(1) parser, 用来解析解析简单的文件啊, 写个简单的语言类似 C 的啊啥的编译器/解释器啥的都特别方便 ....
未知数 2016-12-13
  • 打赏
  • 举报
回复
文档都是markdown写吧,用什么生成器。github、npm这些程序员主流社区的文档全部都是markdown,已经是事实上的规范了
Kevinava 2016-12-05
  • 打赏
  • 举报
回复
eyugod01 2016-12-05
  • 打赏
  • 举报
回复
生成API文档的工具有很多 比如:JSDoc Toolkit和YUIDoc 需要按照这两种API生成文档的要求,给代码加注释,个人觉得已经很好了
我叫小菜菜 2016-12-04
  • 打赏
  • 举报
回复
引用 11 楼 qq_33547043 的回复:
[quote=引用 8 楼 zhi_ai_yaya 的回复:] js可以实现前后台?
nodejs不是可以吗[/quote] 嗯,孤陋寡闻了,一直只是听说nodejs,没有稍微了解过哦。本人还停留在传统技术层面,多学习哈
宝贝安妮 2016-12-02
  • 打赏
  • 举报
回复
引用 8 楼 zhi_ai_yaya 的回复:
js可以实现前后台?
nodejs不是可以吗
jackcong 2016-11-22
  • 打赏
  • 举报
回复
, 问题描述可以再清楚,详细一点。目前并不是太清楚你到底是要做什么,要生成什么。如果是要根据JS的注释生成API的文档,那么JSDoc是可以用的。
liangchengfck1 2016-11-18
  • 打赏
  • 举报
回复
我叫小菜菜 2016-11-10
  • 打赏
  • 举报
回复
js可以实现前后台?
weifeng378 2016-10-31
  • 打赏
  • 举报
回复
60分没人解决这是为什么呢? 很简单你运气不好,这样吧,你把分给我,你的运气马上就会好起来. 我保证马上会有人帮你解决的. 相信我, 一切皆可能.
勤奋的小游侠 2016-10-24
  • 打赏
  • 举报
回复
绝对是重复造轮子。自己上网搜搜可能会有更好的收获
Go 旅城通票 2016-10-21
  • 打赏
  • 举报
回复
其实我是看不懂楼主想要搞什么。。文档生成这种不是js弄的。。设计io操作
引用 2 楼 qq_29594393 的回复:
[quote=引用 1 楼 xietinghmily 的回复:] 60分贴没人解决 额
管理员美女这个问题就交给你啦[/quote]
加载更多回复(3)

87,902

社区成员

发帖
与我相关
我的任务
社区描述
Web 开发 JavaScript
社区管理员
  • JavaScript
  • 无·法
加入社区
  • 近7日
  • 近30日
  • 至今
社区公告
暂无公告

试试用AI创作助手写篇文章吧