我有个想法 是否可以共享文档
发布于 8 年前 作者 zhouchongzxc 3963 次浏览 最后一次编辑是 5 年前

github上可以得到别人的源码,有什么地方可以得到别人的文档呢?

我们可以把自己的文档存储起来,如何让别人也能使用呢?

(我所说的文档很大部分是代码片段 而不是文字说明)

比如说我的文档是这样的:

alt 例子

alt 另一个例子

alt 如何利用片段 如果能得到别人的代码片段是否会有点用处呢?

18 回复

能表达更清楚点吗?

博客不就是文档共享吗

写lisp的大大!

对的。。。进来看到楼主写Lisp就吓傻了

我所说的文档很大部分是代码片段 而不是文字说明 而且是可以独立运行的代码片段

Eclipse中有templete,sublimeText中有snippet,我只是想把他们变成网络版

这样我就可以知道 alsotang

    的 http.createService 是怎么用的了

当然也能知道 aszxqw

    是怎么写的

正则表达式有的时候会记不住,也可以存起来

我总觉得代码之间是有某种模式的,我只是希望将这些模式保存起来,以便自己用,别人也能用。

或许还可以把一本书也存起来,这样就可以自己写书了

(或许是因为我觉得代码提示不够好用)

(好像很散、希望诸位看明白)

明白这个意思了,感觉很有用,但是不知道咋入手,我愿意follow

WIKI + GIST embedded

我觉得我想的不是gist 或 github 更像是npm

感觉这种东西太杂,不太好整理。而且个人习惯不一样的话代码风格也不太一样。实际用起来还是有点问题的。至少我觉得是这样。

或许是你说的那样

但:不好整理 ,又不是不能整理,一天整理一点就可以。 代码风格,总会有人是一样的吧!再说了,简短的代码应该还涉及不到风格吧!

(我想我该换点别的图片。)

@zhouchongzxc 我写的不多,但是我感觉小代码是最成问题的。大规模的可以封装,小的需要直接塞进自己的代码,编码风格确实存在问题。我是不太会用别的的代码段,大多都是自己重写,可能算是强迫症吧。 如果做我觉得把这个功能整合进一个文本编辑器能挺好的。这样导入和管理能方便点。

@Kevin6241

分享代码,首先应该做到分享自己的代码。 别人的代码不改是肯定不能用的。我只是想改的时间比重新写的时间短一点而已。 关于你的最后一句:如果不能做到那样,我觉得他就没有什么存在的必要了。

@zhouchongzxc 如果能实现应该是个不错的功能。我会follow的。

即搜即用的GIST 我的理解

文档中的代码片段只是片段而已。 没有其它的文字,或者src, tests,就像是微观世界的细胞,有生命,但是却没有独立生存下去的意义。

sublime text或者其它文本编辑器中的snippet,之所以有存在的价值,是因为它们依托在使用TE/IDE的你的思维上,但是如果把别人写的文档中的代码片段搜集给你,没有任何意义。

另一个例子,无论是影评、书评还是高中的诗词分析,都不会单纯地只去分析电影、书本身,必须加上背景、情感、遭遇等因素,换成计算机界的俗语就是:上下文(context),所以单纯地这么一个没有上下文的产品没有任何生命可言。 :)

我想楼上误会了吧! 我要的不是文档中的代码,而是我们自己的文档(在其中包含代码并重用,只是他的一部分功能)

我还是不明白楼上是觉得snippet是好还是坏。 我的想法只是把他变成网络版。

============================================================================ 以上是对楼上的回复 以下是我新想到的

。。 我想到了两件事情: 。。 1.应该有交叉参考 2.可以定义各种处理文档的方式 。。。 。。。 1.交叉参考 。 一个类会有许多的方法,如果某两个方法是经常在一起用的 那么就不应该建立两个搜索的关键字 应该建立的是索引表 。 就那mapc来说吧,一般使用mapc的方法是: (let (result item-eval) (mapc (lambda (list-item) (dosomething-with list-item) (setq item-eval (eval-with list-item)) (setq result (sons item-eval result))) list-var)) 。。。。。。。。 。。。。。。。。 (let (result item-eval) (maphash (lambda (key value) (dosomething-with key) (dosomething-with value) (setq item-eval (eval-with value)) (setq result (sons item-eval result))) hash-var)) 。 可以让mapc 和maphash成为搜索的关键字 lambda则另有一张表 用于指向mapc 或maphash 。 。 。 2.可以定义各种处理文档的方式 比如说python的文档是这样的 """ 这是一些说明

import os print(os.platform) """ 。 我们可以从中提取只有 >>> 开始的行 。。 。。 再比如说,有这样的文档: """

goto-sources ?1 ENV_PATH:/src/zxc.cpp 文件说明

goto-sources ?2 ENV_PATH:/conf/color.xml 配置文件说明

“”" 他会让你选择 你选择1的时候会跳转到 ENV_PATH:/src/zxc.cpp (这样就不用在workspace中搜索了)

抱歉 我没有想把字体变成这样

csdn有代码片段功能,不知道是否可共享,楼主可前去看下,好像跟你的需求有点相似 https://code.csdn.net/

回到顶部