blocks|key|448765|text|我不想这么说，但这种情况经常发生--甚至在商业环境中也是如此。如果你真的喜欢一个特定的项目，你就必须开始钻研和学习它。我开始使用未文档库的一种方法是首先在Visual+Studio中创建一个类图。如果开发人员已经注意到了他们的命名约定，那么这些类通常会记录它们自己，您将能够看到它们之间的交互。否则，它真的可以归结为玩它。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|448766|与其一下子着手解决所有的源代码，我建议你有一些你可以努力的东西。例如，查看bug/功能列表。从简单的事情开始，然后一路向上。随着时间的推移，您将越来越熟悉代码库。|448767|我当然不鼓励人们避免编写文档，但我建议所有的开发人员都要习惯于使用没有文档记录的代码。|448768|entityMap^0|0|0|0^^$0|@$1|2|3|4|5|6|7|H|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|I|8|@]|9|@]|A|$]]|$1|D|3|E|5|6|7|J|8|@]|9|@]|A|$]]|$1|F|3|-4|5|6|7|K|8|@]|9|@]|A|$]]]|G|$]]

I hate to say it, but this is often the case --even in a business environment. If you really like a particular project, you're just going to have to start digging in and learning it. One way I have gotten started with undocumented libraries is by first creating a class diagram in Visual Studio. If the developers have been careful about their naming conventions, the classes often document themselves and you'll be able to see their interactions. Otherwise, it really comes down to playing around with it.

Rather than jump in and try to tackle the source head on, all at once, I would recommend you have something that you can work towards. For example, look through the bug/feature list. Start with something simple and then work your way up. In time, you will become more and more familiar with the code base.

I certainly don't encourage people to avoid writing documentation, but I would suggest all developers become comfortable working with code that hasn't been documented.

blocks|key|448724|text|对于我在Insight项目中使用的控件，我面临着这个问题。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|448725|这是我要做的。|448726|448727|阅读源代码，如果源代码可用。如果源代码不可用，请使用|ordered-list-item|448728|获取源代码，并自己与社区一起阅读Reflector。如果有论坛群组，就加入它。发布你的问题，分享你的知识，并成为一个积极的参与者。如果你帮助其他用户，他们更有可能会帮助你。|448729|448730|这就是我的全部。如果这些对你都不起作用，我强烈建议你寻找一个替代方案。|448731|entityMap^0|0|0|0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|O|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|P|8|@]|9|@]|A|$]]|$1|D|3|-4|5|6|7|Q|8|@]|9|@]|A|$]]|$1|E|3|F|5|G|7|R|8|@]|9|@]|A|$]]|$1|H|3|I|5|G|7|S|8|@]|9|@]|A|$]]|$1|J|3|-4|5|6|7|T|8|@]|9|@]|A|$]]|$1|K|3|L|5|6|7|U|8|@]|9|@]|A|$]]|$1|M|3|-4|5|6|7|V|8|@]|9|@]|A|$]]]|N|$]]

I'm faced with this for a control I'm using on the Insight project.

Here's what I do.

<ol>
<li>Read the source code, if it's available.</li>
<li>If the source code isn't available, use Reflector to get the source code, and read that.</li>
<li>Familiarize yourself with the community, if one exists. If there's a forum group, join it. Post your questions, share whatever your knowledge is, and become an active participant. Other users are more likely to help you if you help them.</li>
</ol>

That's all I've got. If none of those work for you, I strongly suggest seeking an alternative if that option is available to you.

blocks|key|490607|text|读一下原文，卢克。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|490608|说真的我没别的办法了。另外:对我来说，学习是有趣的部分……|490609|entityMap^0|0|0^^$0|@$1|2|3|4|5|6|7|F|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|G|8|@]|9|@]|A|$]]|$1|D|3|-4|5|6|7|H|8|@]|9|@]|A|$]]]|E|$]]

Read the source, Luke.

Seriously, I see no other way. Plus: for me, the learning is the fun part...

blocks|key|1855342|text|找到一个更关注其用户的不同框架。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1855343|entityMap^0|0^^$0|@$1|2|3|4|5|6|7|D|8|@]|9|@]|A|$]]|$1|B|3|-4|5|6|7|E|8|@]|9|@]|A|$]]]|C|$]]

Find a different framework that pays attention to its users more.

blocks|key|448813|text|正如Chrys发布的链接中所提到的，您可以尝试使用源代码文档工具来生成文档。您可以在框架的源代码上运行Doxygen或类似的东西，并将其设置为不排除任何未记录的函数或类等。如果您真的喜欢，可以将其内联函数源代码，生成继承、包含、协作、调用者、被调用者和模板实例化关系图，然后您将对整个系统的内部结构有一个相当全面的概述。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|448814|此外，一些文档不足的项目背后有强大的社区，试图将一些东西整合在一起，但还没有完成一些好的东西。你可以加入他们的邮件列表，边走边问问题。|448815|否则，准备好做大量的试验和错误。|448816|entityMap|0|LINK|mutability|MUTABLE|url|http://www.doxygen.org/^0|1F|7|0|0|0|0^^$0|@$1|2|3|4|5|6|7|P|8|@]|9|@$A|Q|B|R|1|S]]|C|$]]|$1|D|3|E|5|6|7|T|8|@]|9|@]|C|$]]|$1|F|3|G|5|6|7|U|8|@]|9|@]|C|$]]|$1|H|3|-4|5|6|7|V|8|@]|9|@]|C|$]]]|I|$J|$5|K|L|M|C|$N|O]]]]

As was mentioned in the link posted by Chrys, you can try using a source code documentation tool to generate documentation. You can run <a href="http://www.doxygen.org" rel="nofollow noreferrer">Doxygen</a> or something similar over the source code of the framework, and set it to not exclude any undocumented functions or classes etc. If you really like, get it to inline function source codes, generate inheritance, include, collaboration, caller, callee and template instantiation diagrams, and you end up with a fairly comprehensive overview of the internals of the entire system.

Also, some poorly documented projects have strong communities behind them trying to get something together, but haven't finished getting something good out. You can join their mailing lists and ask questions as you go along.

Otherwise, be prepared to do a lot of trial-and-error.

blocks|key|1792041|text|有些人喜欢编写单元测试来钻研新代码。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1792042|entityMap^0|0^^$0|@$1|2|3|4|5|6|7|D|8|@]|9|@]|A|$]]|$1|B|3|-4|5|6|7|E|8|@]|9|@]|A|$]]]|C|$]]

There are folks who like to write unit tests to dive into new code.

blocks|key|1790098|text|有时候，开源框架的文档并不是免费的。你需要买下它。也许，这是你的情况？|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1790099|entityMap^0|0^^$0|@$1|2|3|4|5|6|7|D|8|@]|9|@]|A|$]]|$1|B|3|-4|5|6|7|E|8|@]|9|@]|A|$]]]|C|$]]

Sometimes, documentation for opensource frameworks is not free. You need to buy it. Maybe, it is your case?

blocks|key|490631|text|如果有可用的论坛或社区，那么你应该先去那里询问。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|490632|entityMap^0|0^^$0|@$1|2|3|4|5|6|7|D|8|@]|9|@]|A|$]]|$1|B|3|-4|5|6|7|E|8|@]|9|@]|A|$]]]|C|$]]

If there is a forum or a community available, then you should ask there first.

blocks|key|1855316|text|如果很少或根本没有文档/示例，那么是的，阅读源代码是你唯一的出路。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1855317|如果您是框架背后的语言或概念的新手(例如MVC模式)，我建议您尝试寻找更好的文档，因为您不仅要尝试理解代码正在做什么，而且还要了解它为什么要这样做。|1855318|如果你熟悉这门语言，那么它肯定是值得学习的。如果你能让这个框架工作起来，那么至少可以写博客，这样其他处于你这个位置的人就可以得到一些帮助。您也可以考虑通过编写文档来为项目做出贡献……|1855319|entityMap^0|0|0|0^^$0|@$1|2|3|4|5|6|7|H|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|I|8|@]|9|@]|A|$]]|$1|D|3|E|5|6|7|J|8|@]|9|@]|A|$]]|$1|F|3|-4|5|6|7|K|8|@]|9|@]|A|$]]]|G|$]]

If there is little or no documentation / examples, then yes, reading the source code is about your only way forward.

If you are new to the language or concepts behind the framework (e.g. the MVC pattern), I would recommend you try and find something with better documentation, as you will be faced with not only trying to understand the what the code is doing but also why it is doing it.

If you are familiar with the language then it's certainly worth working at it. If you are able to get the framework working, then at the very least blog about it so others in your position can get some help. You could also consider contributing to the project by writing the documentation....

blocks|key|490685|text|如果文档很差或者根本不存在，我就拒绝学习这个框架。使用可能会或不会像我认为的那样工作的东西是没有意义的。将我自己的工作建立在这样的东西上意味着在沙子上构建。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|490686|entityMap^0|0^^$0|@$1|2|3|4|5|6|7|D|8|@]|9|@]|A|$]]|$1|B|3|-4|5|6|7|E|8|@]|9|@]|A|$]]]|C|$]]

If the documentation is poor or non-existent, I refuse to learn the framework. There is no point in working with something that might or might not work as I think it does. Basing my own work on something like that means building on sand.

blocks|key|1855551|text|研究它，记录它，并将补丁发送回项目，这样下一个可怜的灵魂就不必挣扎了。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1855552|同时，问问你自己，为什么你会为一个没有文档的框架而苦苦挣扎？如果它没有记录在案，那么显然，使用它的好处要么被过度炒作，要么没有得到很好的描述。|1855553|entityMap^0|0|0^^$0|@$1|2|3|4|5|6|7|F|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|G|8|@]|9|@]|A|$]]|$1|D|3|-4|5|6|7|H|8|@]|9|@]|A|$]]]|E|$]]

Study it, document it and send patches back to the project so the next poor soul doesn't have to struggle.

In the mean time, ask yourself why you are struggling so much with an undocumented framework? If its that undocumented, clearly, the benefits of using it are either over hyped or not well described.

What's your way to learn an open source project if the project is poorly documented?

Read source code?

How do I learn a poorly documented open source framework?

翻译质量差，导致语言生硬或混乱。

没有提供实际的解决方法或示例。

解答不清晰，无法理解或解决问题。

页面排版不美观，阅读体验差。

文章

问答

视频

教程

学习中心

腾讯云实验室

直播

竞赛

腾讯云代码分析专区

腾讯iOA零信任安全管理系统专区

腾讯云架构师技术同盟交流圈

腾讯云数据库专区

腾讯云智能顾问专区

腾讯云原生专区

腾讯混元专区

腾讯云TCE专区

腾讯云Lighthouse专区

腾讯云HAI专区

腾讯云Edgeone专区

腾讯云存储专区

腾讯云智能专区

腾讯轻联专区 

腾讯云开发专区

TAPD专区

腾讯轻量云游戏服专区

腾讯云最具价值专家

腾讯云架构师技术同盟

腾讯云创作之星

腾讯云开发者先锋

腾讯云AI代码助手

云原生构建

TAPD 敏捷项目管理

Cloud Studio

SDK中心

API中心

命令行工具

功能1上新10个字符

功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符。

功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符。

功能5描述100个字符功能5描述100个字符功能5描述100个字符功能5描述100个字符功能5描述100个字符功能5描述100个字符

功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符

功能4上新

文章&问答评论现已支持表情

全新交互，全新视觉，新增快捷键、悬浮工具栏、高亮块等功能并同时优化现有功能，全面提升创作效率和体验

社区富文本编辑器全新改版！诚邀体验～ 

精选全网热门MCP server，让你的AI更好用 🚀

💥开发者 MCP广场重磅上线！

涵盖代码开发、场景应用、自动测试全流程，助你从零构建专属AI助手

一站式MCP教程库，解锁AI应用新玩法

聚焦“写作效率、视觉美观与运行性能”三方面进行全面升级，为您提供更高效、稳定的创作环境

社区富文本&Markdown编辑器全新改版上线，欢迎大家体验!

诚挚邀请您参与本次调研，分享您的真实使用感受与建议。您的反馈至关重要，感谢您的支持与参与！

社区新版编辑器体验调研

如果一个开源项目没有很好的文档记录，你该如何学习这个项目？阅读源代码？

问我如何学习一个文档不完善的开源框架？
EN

回答 11

Stack Overflow用户

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问我如何学习一个文档不完善的开源框架？EN

回答 11

Stack Overflow用户

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问我如何学习一个文档不完善的开源框架？
EN