blocks|key|145075|text|一年前有一个thread+about+this+on+Slashdot。在常见的Slashdot问题中，有一些很好的答案；也许有人可以在这里提取它们。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|145076|一些好的工具是stepping+through+the+program+with+a+debugger、Doxygen+(当然)(以及相关的工具，如ctag/etags/GNU+Global)、giving+up和a+couple+of+books+about+exactly+this+topic：Michael+Feathers的和Diomidis+Spinellis的。|145077|我个人推荐阅读The+P.G.+Wodehouse+Method+Of+Refactoring；如果没有，它至少是一本有趣的书！|145078|entityMap|0|LINK|mutability|MUTABLE|url|http://ask.slashdot.org/article.pl?sid=08/01/18/1554257|1|http://ask.slashdot.org/comments.pl?sid=422996&cid=22094862|2|http://ask.slashdot.org/comments.pl?sid=422996&cid=22095174|3|http://ask.slashdot.org/comments.pl?sid=422996&cid=22097350|4|http://basildoncoder.com/blog/2008/03/21/the-pg-wodehouse-method-of-refactoring/^0|6|T|0|0|7|18|1|2P|9|2|2Z|16|3|0|7|14|4|0^^$0|@$1|2|3|4|5|6|7|X|8|@]|9|@$A|Y|B|Z|1|10]]|C|$]]|$1|D|3|E|5|6|7|11|8|@]|9|@$A|12|B|13|1|14]|$A|15|B|16|1|17]|$A|18|B|19|1|1A]]|C|$]]|$1|F|3|G|5|6|7|1B|8|@]|9|@$A|1C|B|1D|1|1E]]|C|$]]|$1|H|3|-4|5|6|7|1F|8|@]|9|@]|C|$]]]|I|$J|$5|K|L|M|C|$N|O]]|P|$5|K|L|M|C|$N|Q]]|R|$5|K|L|M|C|$N|S]]|T|$5|K|L|M|C|$N|U]]|V|$5|K|L|M|C|$N|W]]]]

There was a <a href="http://ask.slashdot.org/article.pl?sid=08/01/18/1554257" rel="noreferrer">thread about this on Slashdot</a> a year ago. Amidst the usual Slashdot cruft, there are some good answers; maybe someone can extract them here.

Some good ones are <a href="http://ask.slashdot.org/comments.pl?sid=422996&amp;cid=22094862" rel="noreferrer">stepping through the program with a debugger</a>, Doxygen (of course) (and related tools like ctags/etags/GNU Global), <a href="http://ask.slashdot.org/comments.pl?sid=422996&amp;cid=22095174" rel="noreferrer">giving up</a>, and <a href="http://ask.slashdot.org/comments.pl?sid=422996&amp;cid=22097350" rel="noreferrer">a couple of books about exactly this topic</a>: <a href="https://rads.stackoverflow.com/amzn/click/com/0131177052" rel="noreferrer" rel="nofollow noreferrer">Working Effectively with Legacy Code</a> by Michael Feathers and <a href="https://rads.stackoverflow.com/amzn/click/com/0201799405" rel="noreferrer" rel="nofollow noreferrer">Code Reading: The Open Source Perspective</a> by Diomidis Spinellis.

And I personally recommend reading <a href="http://basildoncoder.com/blog/2008/03/21/the-pg-wodehouse-method-of-refactoring/" rel="noreferrer">The P.G. Wodehouse Method Of Refactoring</a>; if nothing it's at least a fun read!

blocks|key|3362932|text|阅读单元测试。没有单元测试？编写一些单元测试。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|3362933|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|$]]

Read the unit tests. No unit tests? Write some unit tests.

blocks|key|934854|text|你看到this+question了吗？|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|934855|一致的答案似乎是：|934856|直接进入并修复一个bug。选择一个限制到代码库的一小部分。经常使用调试器。|934857|entityMap|0|LINK|mutability|MUTABLE|url|https://stackoverflow.com/questions/215076/whats-the-best-way-to-become-familiar-with-a-large-codebase^0|3|D|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]]]]

Did you see <a href="https://stackoverflow.com/questions/215076/whats-the-best-way-to-become-familiar-with-a-large-codebase">this question</a>? 

The consensus answer there seems to be: 
Dive right in and fix a bug. Pick one limited to to a small portion of the codebase. Use the debugger a lot.

blocks|key|939789|text|我曾经做过几份这样的工作，所有的程序员都离开了公司。我觉得这是个危险信号。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|939790|项目没有文档可能不是巧合，但很难判断其中是否存在因果关系。事实可能是以下任何一种：|939791|在没有documentation.的情况下，由于项目变得太难，程序员离开了|939792|，因为管理层不允许他们记录自己的工作，|unordered-list-item|939793|要求程序员离开，因为他们拒绝记录他们的工作。|939794|939795|熟悉代码的最好方法可能是编写测试。使用可生成代码覆盖率报告的单元测试工具进行设置。编写执行所有代码的测试。代码覆盖率可视化可以帮助您发现您还没有使用过的边缘情况。在这个过程中，我保证您会学到很多关于代码如何工作的知识。附带的好处是，您将生成一个完整的单元测试套件。|939796|其他人已经提到，获得一个生成API文档的工具是另一个选择。这类文档仅供参考。它对于向您展示如何或何时最好地使用给定的类或方法没有什么用处。|939797|另一个练习是为系统的各个部分构建UML图。即使代码的面向对象的体系结构有缺陷，sequence+diagram也是有用的。|offset|length|939798|entityMap|0|LINK|mutability|MUTABLE|url|http://en.wikipedia.org/wiki/Sequence_diagram^0|0|0|0|0|0|0|0|0|13|G|0|0^^$0|@$1|2|3|4|5|6|7|11|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|12|8|@]|9|@]|A|$]]|$1|D|3|E|5|6|7|13|8|@]|9|@]|A|$]]|$1|F|3|G|5|H|7|14|8|@]|9|@]|A|$]]|$1|I|3|J|5|H|7|15|8|@]|9|@]|A|$]]|$1|K|3|-4|5|6|7|16|8|@]|9|@]|A|$]]|$1|L|3|M|5|6|7|17|8|@]|9|@]|A|$]]|$1|N|3|O|5|6|7|18|8|@]|9|@]|A|$]]|$1|P|3|Q|5|6|7|19|8|@]|9|@$R|1A|S|1B|1|1C]]|A|$]]|$1|T|3|-4|5|6|7|1D|8|@]|9|@]|A|$]]]|U|$V|$5|W|X|Y|A|$Z|10]]]]

I've had a couple of jobs like that, where all the programmers had left the company. I'd call that a red flag. 

It's probably no coincidence that the project has no documentation, but it's hard to tell if there's a causal relationship there. The truth could be any of the following:

<ul>
<li>The programmers left because management didn't allow them to document their work.</li>
<li>Management asked the programmers to leave because they refused to document their work.</li>
<li>The programmers left after the project became too difficult to work on, without documentation.</li>
</ul>

Probably the best way to familiarize yourself with the code is to write tests. Set yourself up with a unit testing tool that produces code-coverage reports. Write tests that exercise all the code. The code-coverage visualization helps you to spot edge cases that you haven't exercised yet. As you go through this process, I guarantee you'll learn a lot about how the code works. And as a side benefit, you'll produce a full unit-test suite.

Getting a tool that generates API docs is another option, other people have mentioned. This kind of documentation is only useful for reference. It's not useful for showing you how or when to best use a given class or method.

Another exercise would be to build UML diagrams for parts of the system. A <a href="http://en.wikipedia.org/wiki/Sequence_diagram" rel="nofollow noreferrer">sequence diagram</a> can be useful even when the code's object-oriented architecture is flawed.

blocks|key|4208683|text|我会说，通过大量的测试，如果他们已经建立了某种类型的单元测试框架，那么你就很好，如果没有，那么你可能想要启动一个。因为没有什么比在你试图修复另一件事的时候弄坏另一件事更令人沮丧的了。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|4208684|作为参考，你可能想看看这个，这家伙似乎比你的处境更紧张：|4208685|inherited-a-php-nightmare-where-to-start|offset|length|4208686|entityMap|0|LINK|mutability|MUTABLE|url|https://stackoverflow.com/questions/353795/inherited-a-php-nightmare-where-to-start^0|0|0|0|14|0|0^^$0|@$1|2|3|4|5|6|7|P|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|Q|8|@]|9|@]|A|$]]|$1|D|3|E|5|6|7|R|8|@]|9|@$F|S|G|T|1|U]]|A|$]]|$1|H|3|-4|5|6|7|V|8|@]|9|@]|A|$]]]|I|$J|$5|K|L|M|A|$N|O]]]]

I would say with lots of testing, if they have setup some sort of unit testing framework then you're good, if not, then you might want to start one. As there's pretty much nothing more frustrating than breaking something while you're trying to fix another thing.

and for reference you might want to check this out, this dude seems to be in a tighter spot than you are:

<a href="https://stackoverflow.com/questions/353795/inherited-a-php-nightmare-where-to-start">inherited-a-php-nightmare-where-to-start</a>

blocks|key|934707|text|哪种编程语言？代码库有多大(1k、10k、100k行？)|type|unstyled|depth|inlineStyleRanges|entityRanges|data|934708|在任何情况下，我都建议使用Doxygen创建易于浏览的HTML交叉引用。|offset|length|934709|entityMap|0|LINK|mutability|MUTABLE|url|http://www.doxygen.org/^0|0|D|7|0|0^^$0|@$1|2|3|4|5|6|7|N|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|O|8|@]|9|@$D|P|E|Q|1|R]]|A|$]]|$1|F|3|-4|5|6|7|S|8|@]|9|@]|A|$]]]|G|$H|$5|I|J|K|A|$L|M]]]]

Which programming language? How big is the code base (1k, 10k, 100k lines?)

In any case, I recommend using <a href="http://www.doxygen.org/" rel="nofollow noreferrer">Doxygen</a> to create HTML cross-reference that is easy to browse around.

blocks|key|145222|text|如果它足够小(比方说10,000行或更少)，我已经在很好的旧清单上取得了相当大的成功。把代码打印出来，拿一些高亮的钢笔和那些彩色的便利贴，看一遍清单，草草写下笔记，找出参考资料，然后拼凑出整体结构。找个安静的地方去做这件事，然后花时间复习一下代码。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|145223|如果它是用ctag或类似的东西编写的，那么带上笔记本电脑，这样你就可以搜索代码了。|145224|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|$]]

If it's small enough to do this (say 10,000 lines or less) I've had a fair degree of success with good old fashoned listings. Print out the code, get some highlighter pens and those coloured post-it flags and go over the listing, scribbling notes, finding references and piecing together the overall structure. Go somewhere quiet to do it and just spend the time to go over the code.

If it's written in something you can use ctags or something similar on, take a laptop so you can search the code.

blocks|key|4208976|text|THe我经常做的第一件事(在VisualStudio中)是为解决方案中的每个项目创建一个类图。这让我看到了我正在使用的图形表示。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|4208977|出于某种原因，我只是拿着一个黄色的便签簿浏览主要的课程，并草草记下什么是对话，什么是对话。这似乎对我很有效。我真的不知道为什么，或者为什么它比仅仅阅读代码更好。|4208978|此外，如果有一些令人困惑的代码，你不知道它是如何工作的，那么就通过调试器运行它并逐步执行它。我总是试图保持调用堆栈可见，这样我就可以感觉到不同的代码路径。|4208979|最后一件事(这可能不是每个人都会想到的)是通过分析器运行它。您不一定要寻找性能数字，但您对捕获的代码路径感兴趣。当它运行时，它实际上对于查看实际发生的事情非常有用。|4208980|entityMap^0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|J|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|K|8|@]|9|@]|A|$]]|$1|D|3|E|5|6|7|L|8|@]|9|@]|A|$]]|$1|F|3|G|5|6|7|M|8|@]|9|@]|A|$]]|$1|H|3|-4|5|6|7|N|8|@]|9|@]|A|$]]]|I|$]]

THe first thing I always do (in VisualStudio) is create a class diagram of each project in a solution. That lets me see a graphical representation of what I'm working with.

And for some reason I just go through the major classes with a yellow legal pad and just jot down notes on what talks to what. This seems to work for me. Don't really know why, or why its any better than just reading the code.

Also, if there are confusing bits of code that you don't know how its supposed to work, then run it through the debugger and step through it. I always try to keep the call stack visible so I get a feel for the different code paths.

One last thing (and this might not occur to everyone) is run it through a profiler. You are not necessarily looking for performance numbers, but you are interested in the captured code paths. Its actually very useful for seeing what actually is happening when it runs.

I don't know, I've been told that the previous developers did fine in picking up and heading straight into coding with no major problem. I wonder if I am doing it wrong by requesting my manager for some brief meetings with some senior programmers here. Is it better to be cautious and finish this time sensitive tracker the long way, or rush it to meat the deadline? 

Just on the side note, the previous programmers who maintain this app are all gone after less than a year in the company. Don't know if there's any relation in anything.

How do you familiarize with a codebase that has no documentation?

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

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

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

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

文章

问答

视频

教程

学习中心

腾讯云实验室

直播

竞赛

腾讯云代码分析专区

腾讯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

回答 8

Stack Overflow用户

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问如何熟悉没有文档的代码库？EN

回答 8

Stack Overflow用户

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问如何熟悉没有文档的代码库？
EN