评论Banner/Header最佳实践/示例？

很久以前,我快速浏览了一些代码(PERL ... urp),我的一位经理正在编写并被他在代码中使用的横幅/标题系统震惊.我没有机会详细研究他的代码,但只是从屏幕上的横幅评论我可以很容易地告诉代码的意图,即使是从很远的地方.

不幸的是,很久以前,我们当时的谈话并不适合我说:"是的,好好忘记我们的dot-com创业公司上厕所,我可以记下你的编码风格吗？"

多年以后,我还没有达到一种高级评论风格,这种评论风格与我当天看到的(现在可能是神话般的)代码一样清晰.

当我说"横幅"时,我指的是许多程序员用来在代码中创建更高级别设计的高级块分区/标题.它们通常由简单的ASCII破折号,斜线,等号等组成.在我目前的日常使用语言中,一个代码标题/标题层次结构可能是:

# ========================================================
# = Header 1
# ========================================================

# --------------------------------------------------------
# - Header 2
#---------------------------------------------------------

# == Header 3 ============================================

# -- Header 4 --------------------------------------------

# Header 5

和所有通常的变化.

虽然我的搜索没有引起任何值得注意的事实,但网上某处某人试图收集这些例子并以系统的方式呈现它们？

有人能指出他们发现有用的横幅评论风格"系统"吗？我不是在想"哦,我喜欢使用星号的那些",但更多的是整体风格策略,使高级代码构建快速易懂,易于理解？明显地,从示例中挑选优选系统比比较描述更容易.

注意:我对评论本身的内容不感兴趣,但评论中使用的"天赋"提供了整体代码内容和组织的明确指示.